Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

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

Body

application/json

Webhook endpoint details.

Fields for creating a webhook endpoint.

name
string
required

Human-readable name for the endpoint.

Example:

"Production events"

url
string<uri>
required

HTTPS URL that event notifications are delivered to.

Example:

"https://api.example.com/webhooks/hifi"

description
string

Optional description of the endpoint.

Example:

"Receives all production event notifications"

subscriptions
enum<string>[]

Event types this endpoint subscribes to.

A webhook event type that an endpoint can subscribe to.

Available options:
USER_CREATED,
KYC_SUBMITTED,
KYC_UNDER_REVIEW,
KYC_RFI,
KYC_APPROVED,
KYC_REJECTED,
ACCOUNT_ACTIVE,
ACCOUNT_INACTIVE,
VIRTUAL_ACCOUNT_CREATED,
VIRTUAL_ACCOUNT_UPDATED,
ONRAMP_CREATED,
ONRAMP_UPDATE,
OFFRAMP_CREATED,
OFFRAMP_UPDATED
Example:

Response

Webhook endpoint created successfully. The signingSecret is returned only here.

A newly created webhook endpoint. Includes the signingSecret, which is returned only in this response and cannot be retrieved again.

id
string

Public ID of the webhook endpoint (prefixed with we_).

Example:

"we_4mNpXwZ7bV1aLcs3Kf9dQ"

name
string
Example:

"Production events"

url
string<uri>
Example:

"https://api.example.com/webhooks/hifi"

description
string
Example:

"Receives all production event notifications"

subscriptions
enum<string>[]

Event types this endpoint is subscribed to.

A webhook event type that an endpoint can subscribe to.

Available options:
USER_CREATED,
KYC_SUBMITTED,
KYC_UNDER_REVIEW,
KYC_RFI,
KYC_APPROVED,
KYC_REJECTED,
ACCOUNT_ACTIVE,
ACCOUNT_INACTIVE,
VIRTUAL_ACCOUNT_CREATED,
VIRTUAL_ACCOUNT_UPDATED,
ONRAMP_CREATED,
ONRAMP_UPDATE,
OFFRAMP_CREATED,
OFFRAMP_UPDATED
Example:
status
enum<string>
Available options:
ACTIVE,
PAUSED,
DISABLED
Example:

"ACTIVE"

createdAt
string<date-time>
Example:

"2026-07-01T10:30:00.000Z"

updatedAt
string<date-time>
Example:

"2026-07-01T10:30:00.000Z"

signingSecret
string

Secret used to verify the signature of incoming deliveries. Returned only on creation.

Example:

"whsec_9aB0xY4mNpXwZ7bV1aLdt3Kf9dQ2mNpXwZ7bV1aLcs"