Webhooks API

Manage webhook endpoints programmatically.

The Webhook Endpoint object

{
  "id": "we_abc123",
  "object": "webhook_endpoint",
  "url": "https://yoursite.com/webhooks/ikawaari",
  "events": ["payment_intent.succeeded", "payment_intent.payment_failed"],
  "enabled": true,
  "secret": "whsec_...xxxx",
  "created": 1708300800
}

Endpoints

Method	Endpoint	Description
POST	/v1/webhooks	Create a webhook endpoint
GET	/v1/webhooks/{id}	Retrieve a webhook endpoint
PATCH	/v1/webhooks/{id}	Update a webhook endpoint
DELETE	/v1/webhooks/{id}	Delete a webhook endpoint
GET	/v1/webhooks	List webhook endpoints
POST	/v1/webhooks/{id}/test	Send a test event

Create a Webhook Endpoint

POST /v1/webhooks

Parameter	Type	Required	Description
url	string	✅	The URL to receive webhook events
events	string[]	✅	List of event types to subscribe to
enabled	boolean		Whether the endpoint is active (default: true)