Skip to main content
PATCH
Update Trigger Subscription

Authorizations

Authorization
string
header
required

Your Paragon User Token (JWT), which you can generate using your project's signing keys.

Path Parameters

project_id
string
required

Your Paragon Project ID

subscription_id
string<uuid>
required

The trigger subscription ID

Body

application/json
parameters
object

The trigger configuration parameters to update. Omitted keys unchanged, provided keys overwrite, null removes keys.

webhookOverride
object | null

Update or clear (with null) the webhook override

Response

Success - Returns the updated trigger subscription

id
string<uuid>
required

The subscription ID

Example:

"<uuid>"

type
string
required

The trigger type

Example:

"SALESFORCE_TRIGGER_RECORD_CREATED"

parameters
object
required

The trigger configuration parameters

Example:
status
enum<string>
required

ACTIVE: currently receiving events. ERRORED: errors checking for records or repeated webhook delivery issues resulted in the trigger being disabled.

Available options:
ACTIVE,
ERRORED
dateCreated
string<date-time>
required

The date the subscription was created

Example:

"2025-05-31T00:00:00Z"

dateLastReceivedEvent
string<date-time>
required

For polling triggers: date we last checked for new records. For webhook triggers: date we last received a webhook event.

Example:

"2025-05-31T00:00:00Z"

credentialId
string<uuid>
required

The credential ID associated with this subscription

Example:

"<uuid>"

error
string

The reason for an error (only present when status is ERRORED)

Example:

"Failed to check for new records after repeated failures. Last error: Request failed with 500 { ... error info ... }"

webhookOverride
object

Undefined if no webhook override is set for this subscription