Checkout Page
Support
Log inSign up

Update a webhook

Updates the name, URL, subscribed events, custom headers or status of a webhook. Only supplied fields change; events and customHeaders are replaced wholesale. The URL must use https and must not be registered on another of your webhooks. Set status to inactive to pause deliveries and active to resume; failed is system-managed. The secret cannot be changed here. An empty body is accepted and leaves the webhook unchanged.

PATCH/v1/webhooks/:webhookId

Authorization

api_key_auth
AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Path Parameters

webhookId*string

The webhook ID, as returned by create or list.

Match^[0-9a-fA-F]{24}$

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

application/json

application/json

application/json

curl -X PATCH "https://api.checkoutpage.com/v1/webhooks/:webhookId" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "string",
    "name": "string",
    "url": "string",
    "events": [
      "webhook.test"
    ],
    "status": "active",
    "apiVersion": "v1",
    "customHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "deliveryCount": 0,
    "successCount": 0,
    "failureCount": 0,
    "lastTriggeredAt": "string",
    "lastSuccessAt": "string",
    "lastFailureAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}