Webhooks
Update webhook
Update an existing webhook.
POST
/
webhooks
/
:id
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
api_version
string
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>[]
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
status
enum<string>
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
message
string