Create webhook subscription

Create a webhook subscription. The response includes a signing secret exactly once; persist it securely because later reads omit it.

POST /v0/webhook_subscriptions

Create webhook subscription

cURL

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": [
    "page.version.created"
  ],
  "active": true
}
'

201

{
  "subscriptionId": "<string>",
  "url": "<string>",
  "events": [
    "page.version.created"
  ],
  "active": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "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

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 · default: true · required

Whether the subscription should be active

Example:

true

Response

201

application/json

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

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}$

signingSecret · string · required

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