Skip to main content
POST
/
v1
/
webhooks
Register a webhook
curl --request POST \
  --url http://localhost:3000/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "enabled_events": [
    "analysis.queued"
  ],
  "name": "<string>",
  "description": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string<uri>
required
Maximum string length: 2048
​
enabled_events
enum<string>[]
required
Minimum array length: 1
Available options:
analysis.queued,
analysis.completed,
analysis.failed,
persona.assigned,
methodology.assigned,
profile.synthesized,
playbook.draft.completed,
playbook.published,
insights.generated,
batch.completed,
batch.item.completed,
batch.item.failed,
export.ready,
webhook.test
​
name
string
Maximum string length: 120
​
description
string
Maximum string length: 2000

Response

200

Default Response