Skip to main content
POST
Register Webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
company_nanoid
string
required

Unique identifier of the company.

Required string length: 15
Pattern: ^co-.*
url
string<uri>
required
team_nanoid
string

Unique identifier of the team.

Required string length: 15
Pattern: ^te-.*
webhook_version
enum<string>
default:v2

v2: HMAC-signed payloads (requires secret and events). v1: Ethereum-signed legacy payloads (omit secret; receives all events).

Available options:
v1,
v2
events
string[]

Required for v2: non-empty list of subscribed event types. For v1 omit or use []; v1 always receives all events.

secret
string

Required for v2 (minimum 16 characters). Must be omitted for v1.

Minimum string length: 16
is_active
boolean
name
string

Optional display name for the webhook.

Maximum string length: 255
description
string

Optional description for the webhook.

Response

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required