Sign in

v1

latestOpenAPI 3.0.02026-07-14664396.8 KB
SETUP

Update webhook

Updates the webhook configuration for the authenticated business.

put/webhooks/url/config

Headers

api-keystring
Example:alfredpay.T+QdhCoMofy8.gGKO5KdB7M+B/9jLFef

API Key for service authentication (alternative to JWT Bearer token). Optional.

api-secretstring
Example:PwF+cDGZd37eHYZ.CVvF1/zbHCBosSo1

API Secret for service authentication (alternative to JWT Bearer token). Optional.

Request body

urlstring required

Webhook URL where events will be sent. Must be a valid HTTPS URL

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required
headersobject

Custom headers to include in webhook requests. Common headers like Content-Type and Authorization can be specified here

Example request

{
  "url": "https://payments-webhooks.com/events",
  "headers": {
    "Content-Type": "application/json",
    "accept": "application/json",
    "Authorization": "Bearer token123"
  }
}

Response

Webhook configuration updated successfully

object required