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

Update webhook endpoint

Update a webhook endpoint. Only the provided fields change.

Test webhook endpoint POST

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

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

PUT
/webhooks/{id}

application/json

id*string
curl -X PUT "https://commet.co/api/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
url?string
Formaturi
events?array<>
Items1 <= items
description?|
isActive?boolean
apiVersion?string

Destination URL (HTTPS)

Webhook events to subscribe to

Pin the endpoint to an API version

Update a webhook endpoint. Only the provided fields change.

Webhook endpoint public ID

{
  "success": true,
  "data": {
    "object": "webhook",
    "livemode": true,
    "id": "string",
    "url": "http://example.com",
    "events": [
      "string"
    ],
    "description": "string",
    "isActive": true,




{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
"apiVersion": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
}