B2B Webhooks

Register Webhook

post/v2/webhooks/register

Request

Base URL
https://b2b-api.dev-riseworks.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/riseworks/apis/b2b-api-v1-legacy/docs/v2/webhooks/register/post.ts
A function with typed inputs. Its response is checked against the schema.

company_nanoidstring required

Unique identifier of the company.

team_nanoidstring

Unique identifier of the team.

urlstring uri required

webhook_version'v1' | 'v2'

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

eventsstring[]

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

secretstring

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

is_activeboolean

namestring

Optional display name for the webhook.

descriptionstring

Optional description for the webhook.

Default Response

successtrue required

No recorded changes to this operation across all 1 revision of this API.