Commet
  • Pricing
Log InTry out
Create webhook endpoint POSTDelete webhook endpoint DELETEGet webhook endpoint GETList webhook endpoints GETTest webhook endpoint POSTUpdate webhook endpoint PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Test webhook endpoint

Send a test event to a webhook endpoint to verify connectivity.

POST
/webhooks/{id}/test

Send a test event to a webhook endpoint to verify connectivity.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhooks/string/test"
{  "success": true,  "data": {    "success": true,    "deliveryId": "string",    "deliveredAt": "2019-08-24T14:15:22Z",    "object": "webhook",    "livemode": true  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

List webhook endpoints GET

List webhook endpoints with cursor-based pagination.

Update webhook endpoint PUT

Update a webhook endpoint. Only the provided fields change.