Webhook Endpoints
Update a webhook endpoint
Partially updates a webhook endpoint’s URL, event subscriptions, or enabled state.
PATCH
Update a webhook endpoint
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
Webhook endpoint UUID.
Body
application/json
Available options:
checkout.completed, customer.created, customer.updated, order.created, order.updated, order.refunded, subscription.created, subscription.updated, subscription.cancelled, subscription.plan_changed, subscription.trial_will_end, invoice.created, invoice.paid, invoice.payment_failed, refund.created, refund.updated, feature.usage_alert, payment_method.created, payment_method.updated, payment_method.deleted Response
Updated webhook endpoint.
Example:
"2f6b9e2a-7c1a-4a3e-8b6e-8e6f9a2c1d4a"
Destination URL that webhook events are POSTed to.
Example:
"https://example.com/webhooks/kelviq"
Disabled endpoints don't receive deliveries.
Event types this endpoint is subscribed to.
Available options:
checkout.completed, customer.created, customer.updated, order.created, order.updated, order.refunded, subscription.created, subscription.updated, subscription.cancelled, subscription.plan_changed, subscription.trial_will_end, invoice.created, invoice.paid, invoice.payment_failed, refund.created, refund.updated, feature.usage_alert, payment_method.created, payment_method.updated, payment_method.deleted Signing secret used to verify the Kelviq-Signature header on deliveries to this endpoint.