Skip to main content
PATCH
/
v0
/
webhook_subscriptions
/
{subscription_id}
Update webhook subscription
curl --request PATCH \
  --url https://api.tryarchitect.com/v0/webhook_subscriptions/{subscription_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "active": true
}
'
{
  "subscriptionId": "<string>",
  "url": "<string>",
  "events": [],
  "active": true,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryarchitect.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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
​
active
boolean
required

Whether the subscription is active

​
createdAt
string
required
Pattern: ^\+[1-9]\d{1,14}$
​
updatedAt
string
required
Pattern: ^\+[1-9]\d{1,14}$