Create a webhook subscription

POST

/webhooks

Subscribe an HTTPS endpoint to one or more events. The response includes a signing secret used to verify deliveries, shown once. An API key needs the webhooks:write scope. A name that is not an event is rejected with 400.

Authorization

headerAuthorizationBearer <API key>

API key in the Authorization header: Authorization: Bearer ace_live_.... Use an ace_test_... key for the free, rate-capped sandbox.

Request Body

application/json

body

url*string

Must be an HTTPS URL.

Formaturi

events*array<string>

Event types, e.g. content.approved, feed.source.refreshed, enrichment.job.succeeded.

description?string

Response Body

Created

application/json

response

data?

Example Request

curl -X POST 'https://example.com/api/v1/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com",
  "events": [
    "string"
  ]
}'

Example Request

curl -X POST 'https://example.com/api/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "events": [    "string"  ]}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "url": "http://example.com",
    "events": [
      "string"
    ],
    "secret": "string",
    "is_active": true,
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "url": "http://example.com",    "events": [      "string"    ],    "secret": "string",    "is_active": true,    "description": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Create a webhook subscription

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Request Body

Response Body