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

List webhook endpoints

List webhook endpoints with cursor-based pagination.

GET
/webhooks

List webhook endpoints with cursor-based pagination.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

cursor?string
Length1 <= length
limit?integer
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhooks"
{  "object": "list",  "data": [    {      "id": "string",      "url": "string",      "events": [        "string"      ],      "description": "string",      "isActive": true,      "apiVersion": "string",      "createdAt": "2019-08-24T14:15:22Z",      "object": "webhook",      "livemode": true    }  ],  "hasMore": true,  "nextCursor": "string"}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Get webhook endpoint GET

Retrieve a webhook endpoint by its public ID.

Test webhook endpoint POST

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