Skip to main content
POST
/
v0
/
webhook_subscriptions
Create webhook subscription
curl --request POST \
  --url https://api.tryarchitect.com/v0/webhook_subscriptions \
  --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": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "signingSecret": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
​
url
string<uri>
required

URL to open when action is triggered

​
events
enum<string>[]
required

Event types to subscribe to

Minimum array length: 1

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
Example:
[
  "page.version.created",
  "page.version.processed",
  "page.version.published"
]
​
active
boolean
default:true
required

Whether the subscription should be active

Example:

true

Response

WebhookSubscription created successfully

​
subscriptionId
string
required

Unique subscription identifier

​
url
string<uri>
required

URL to open when action is triggered

​
events
enum<string>[] | null
required

Subscribed event types. null means the subscription receives every supported event.

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<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))$
​
signingSecret
string
required

Webhook signing secret. Store this value now because it is only returned when the subscription is created.