Skip to main content
POST
/
v1
/
workspaces
/
{workspaceId}
/
webhooks
Create Webhook
curl --request POST \
  --url https://8511e6e5e351.ngrok-free.app/v1/workspaces/{workspaceId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://hearthfurniture.com/webhook",
  "eventType": "page.created"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "https://hearthfurniture.com/webhook",
  "eventType": "page.created"
}

Authorizations

​
Authorization
string
header
required

The API key for the App (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)

Path Parameters

​
workspaceId
string<uuid>
required

Body

application/json
​
url
string<uri>
required
Example:

"https://hearthfurniture.com/webhook"

​
eventType
enum<string>
required
Available options:
page.created,
page.deleted,
page.updated,
page.restored,
site.published

Response

201 - application/json
​
id
string<uuid>
required
​
workspaceId
string<uuid>
required
​
url
string<uri>
required
Example:

"https://hearthfurniture.com/webhook"

​
eventType
enum<string>
required
Available options:
page.created,
page.deleted,
page.updated,
page.restored,
site.published