Update a webhook endpoint

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url?string

The URL to send webhook events to. Must be https.

description?string

Human-readable description for the endpoint

enabledEvents?array<string>

List of event types to subscribe to. Use ['*'] for all events.

status?string

Endpoint status

metadata?

Custom metadata key-value pairs

Response Body

`application/json`

curl -X PATCH "https://example.com/webhook-endpoints/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "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