Skip to main content
PATCH
Update webhook subscription

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

subscription_id
string
required

The webhook subscription ID

Body

application/json
url
string<uri>

URL to open when action is triggered

events
enum<string>[]

Supported outbound webhook event types. page.version.* events correspond to Audience version lifecycle changes in Customer API terminology.

Available options:
page.version.created,
page.version.processed,
page.version.published,
form.submitted,
form.enriched,
form.enrichment_failed,
billing.trial.spend_threshold.v1,
billing.trial.capped.v1,
self_serve.signup_enriched,
self_serve.tenant_pre_approved
active
boolean

Response

Successful operation

subscriptionId
string
required

Unique subscription identifier

url
string<uri>
required

URL to open when action is triggered

events
enum<string>[] | null
required

Supported outbound webhook event types. page.version.* events correspond to Audience version lifecycle changes in Customer API terminology.

Available options:
page.version.created,
page.version.processed,
page.version.published,
form.submitted,
form.enriched,
form.enrichment_failed,
billing.trial.spend_threshold.v1,
billing.trial.capped.v1,
self_serve.signup_enriched,
self_serve.tenant_pre_approved
active
boolean
required

Whether the subscription is active

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$