Webhooks API

Manage webhook endpoints programmatically.

Current implemented route family: webhook_endpoints

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	/webhook_endpoints	Create a webhook endpoint
GET	/webhook_endpoints/{id}	Retrieve a webhook endpoint
GET	/webhook_endpoints	List webhook endpoints
POST	/webhook_endpoints/{id}	Update a webhook endpoint
POST	/webhook_endpoints/{id}/rotate_secret	Rotate a webhook signing secret

Merchant dashboard APIs also expose additional webhook management operations under merchant route families, including test, replay, and attempts inspection.

Create a Webhook Endpoint

POST /webhook_endpoints

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)