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

Get webhook endpoint

Retrieve a webhook endpoint by its public ID.

GET
/webhooks/{id}

Retrieve a webhook endpoint by its public ID.

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 GET "https://example.com/webhooks/string"
{  "success": true,  "data": {    "id": "string",    "url": "string",    "events": [      "string"    ],    "description": "string",    "isActive": true,    "apiVersion": "string",    "createdAt": "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"  }}

Delete webhook endpoint DELETE

Permanently delete a webhook endpoint.

List webhook endpoints GET

List webhook endpoints with cursor-based pagination.