Skip to main content
POST
Register a webhook

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,
all_day_session.processing_started,
all_day_session.detected,
all_day_session.completed,
all_day_session.failed,
webhook.test
name
string | null
Maximum string length: 120
description
string | null
Maximum string length: 2000

Response

200

Default Response