Checkout Page
Support
Log inSign up

Get a webhook

Returns one webhook by id, including its subscribed events, status and delivery counters. The signing secret is never returned — it is only available in the create response.

GET/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}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.checkoutpage.com/v1/webhooks/:webhookId"
{
  "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
}