POST
/
webhooks

Authorizations

Authorization
string
headerrequired

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

Body

application/json
api_version
string
required

The version of the API for which you registered the webhook. This helps to maintain backward compatibility. If in newer versions the event payload is changed, your webhook will keep receiving the payload from this api version. This will be 'v1.0' for now and we will come up with more versions and a changelog later.

name
string

Optional name to define the purpose of the webhook.

topics
enum<string>[]
required

An array of topics to listen to. When any of these topics are triggered, the webhook will be pinged.

Available options:
REGISTRATIONS.EXISTING.VALIDATION.FAILED,
REGISTRATIONS.EXISTING.VALIDATION.SUCCEEDED,
REGISTRATIONS.NEW.SUCCEEDED,
REGISTRATIONS.NEW.INVALID,
EXEMPTION_CERTIFICATES.VERIFICATION.FAILED,
EXEMPTION_CERTIFICATES.VERIFICATION.SUCCEEDED,
EXEMPTION_CERTIFICATES.EXPIRATION,
NEXUS.THRESHOLD.STATE.ALERT
url
string
required

Your webhook url that will be hit once an event happens. Only HTTPS urls are allowed.

key
string
required

Secure string provided by the user. It will be used during HMCA process to keep the event payloads secure. Make sure to keep it safe as you will need it during validating event payloads. This key won't be returned back by any other endpoint.

status
enum<string>
required

If the webhook is active or not. If a webhook is disabled it won't be called when a topic is triggered.

Available options:
ENABLED,
DISABLED

Response

200 - application/json
data
object
message
string
Topics and EventsGet webhook