Get webhook
Get a webhook registered with Commenda.
curl --request GET \
--url http://staging.api.commenda.io/api/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"api_version": "v1.0",
"name": "handle_existing_registrations_validation_failure",
"topics": [
"INCORPORATION_REQUEST.SUCCEEDED"
],
"url": "https://bruno-simon.com/",
"status": "ENABLED",
"created_at": 1727284490
},
"message": "Successfully fetched webhook."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the webhook to get.
Response
The unique identifier for this webhook. You will need this if you need to update or delete this webhook.
"2535af08-a139-4d0c-9827-1651e46dfbcf"
The version of the API for which you registered the webhook. This will be 'v1.0' for now. This helps to maintain backward compatibility. If in newer versions the event payload is changed, your webhook will keep receiving the payload from the original api version.
"v1.0"
Optional name to define the purpose of the webhook.
"handle_existing_registrations_validation_failure"
An array of topics to listen to. When any of these topics are triggered, the webhook will be pinged.
INCORPORATION_REQUEST.SUCCEEDED, INCORPORATION_REQUEST.NEEDS_ADDITIONAL_INFO, INCORPORATION_REQUEST.COMPLETED Your webhook url that will be hit once a topic is triggered. Only https:// urls will work.
"https://bruno-simon.com/"
If the webhook is active or not. If a webhook id disabled it won't be called when a topic is triggered.
ENABLED, DISABLED Timestamp in UTC when this webhook was created.
1727284490
"Successfully fetched webhook."
Was this page helpful?
curl --request GET \
--url http://staging.api.commenda.io/api/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"api_version": "v1.0",
"name": "handle_existing_registrations_validation_failure",
"topics": [
"INCORPORATION_REQUEST.SUCCEEDED"
],
"url": "https://bruno-simon.com/",
"status": "ENABLED",
"created_at": 1727284490
},
"message": "Successfully fetched webhook."
}