Commet
  • Precios
Iniciar SesiónRegistrarse
Create webhook endpoint POSTDelete webhook endpoint DELETEGet webhook endpoint GETList webhook endpoints GETTest webhook endpoint POSTUpdate webhook endpoint PATCH
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

Create webhook endpoint

Create a new webhook endpoint. The response includes the signing secret which is only returned once.

POST
/webhooks

Create a new webhook endpoint. The response includes the signing secret which is only returned once.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

Unique key used to safely retry this write for 24 hours without applying it twice.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string
Formaturi
Length1 <= length
events*array<>
Items1 <= items
description?string
apiVersion?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "events": [      "subscription.created"    ]  }'
{  "id": "string",  "url": "string",  "events": [    "string"  ],  "description": "string",  "isActive": true,  "apiVersion": "string",  "createdAt": "2019-08-24T14:15:22Z",  "secretKey": "string",  "object": "webhook",  "livemode": true}
{  "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"  }}
{  "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"  }}

Track usage event POST

Track a usage event for a metered feature. Deducts from balance/credits if applicable.

Delete webhook endpoint DELETE

Permanently delete a webhook endpoint.