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

The webhook endpoint URL

​
events
enum<string>[]
required
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

Response

201 - application/json

WebhookSubscription created successfully

​
id
string
required

Unique subscription identifier

​
url
string<uri>
required

The webhook endpoint URL

​
events
enum<string>[] | null
required
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
​
updatedAt
string<date-time>
required
​
signingSecret
string
required

The signing secret for the subscription