Create a webhook endpoint
Register a new webhook endpoint. HIFI delivers event notifications to the
endpoint’s url for every event type listed in subscriptions.
A signing secret is generated on creation and returned once in the
signingSecret field of this response only. Use it to verify the
signature of incoming webhook deliveries. It is not returned by any other
endpoint, so store it securely.
A profile may have at most 16 active webhook endpoints.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Webhook endpoint details.
Fields for creating a webhook endpoint.
Human-readable name for the endpoint.
"Production events"
HTTPS URL that event notifications are delivered to.
"https://api.example.com/webhooks/hifi"
Optional description of the endpoint.
"Receives all production event notifications"
Event types this endpoint subscribes to.
A webhook event type that an endpoint can subscribe to.
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 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.
Public ID of the webhook endpoint (prefixed with we_).
"we_4mNpXwZ7bV1aLcs3Kf9dQ"
"Production events"
"https://api.example.com/webhooks/hifi"
"Receives all production event notifications"
Event types this endpoint is subscribed to.
A webhook event type that an endpoint can subscribe to.
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 ACTIVE, PAUSED, DISABLED "ACTIVE"
"2026-07-01T10:30:00.000Z"
"2026-07-01T10:30:00.000Z"
Secret used to verify the signature of incoming deliveries. Returned only on creation.
"whsec_9aB0xY4mNpXwZ7bV1aLdt3Kf9dQ2mNpXwZ7bV1aLcs"