Skip to main content
POST
Add a webhook endpoint

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Body

application/json
url
string
required

An https URL that answers POST requests from the internet.

Required string length: 1 - 2048
events
string[]
required

Webhook event types from list_event_types, or ["*"] for all of them: client.created, client.invited, client.joined, checklist.sent, checklist.item_submitted, checklist.item_changes_requested, checklist.completed, document.uploaded, fact.accepted, account.connected, account.disconnected, message.created.

Required array length: 1 - 48 elements
Maximum string length: 100
description
string · null · null

A note for the firm about what the endpoint is for.

Maximum string length: 200

Response

Created.

object
enum<string>
required
Available options:
webhook_endpoint
endpoint
object
required
secret
string
required

The signing secret. Store it now: it is not shown again.