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

Update webhook endpoint

Update a webhook endpoint. Only the provided fields change.

PUT
/webhooks/{id}

Update a webhook endpoint. Only the provided fields change.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}

Test webhook endpoint POST

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

url?string
events?array<>
description?string|null
isActive?boolean
apiVersion?string