docs

Get a webhook endpoint

Retrieves a webhook endpoint by ID.

GET
/webhook-endpoints/{id}

Retrieves a webhook endpoint by ID.

Authorization

api-key
AuthorizationBearer <token>

API key for merchant integrations. Send as Authorization: Bearer <your key>.

In: header

Path Parameters

id*string

Webhook endpoint ID

Response Body

application/json

curl -X GET "https://example.com/webhook-endpoints/string"
{
  "id": "we_abc123def456",
  "object": "webhook_endpoint",
  "url": "https://example.com/webhooks",
  "description": "Production webhook",
  "status": "enabled",
  "enabledEvents": [
    "charge.succeeded",
    "payment_intent.created"
  ],
  "livemode": false,
  "secret": "whsec_abc123def456ghi789",
  "metadata": {
    "environment": "production"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}
Empty

Create a webhook endpoint POST

Creates a new webhook endpoint. The response includes the signing secret which is only shown once. Store it securely to verify webhook signatures.

Update a webhook endpoint PATCH

Updates a webhook endpoint. You can update the URL, description, enabled events, status, or metadata.