curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/webhook-endpoint \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://hooks.example.com/paypathiq"
}
'Configure the webhook endpoint
Requires webhooks:manage. Configures the single HTTPS destination that receives minimal, signed change notifications for this Client, or replaces it and re-enables a disabled endpoint. The first call returns 201 with the signing secret, shown once; later calls return 200 without it (rotate to obtain a new one). PayPathIQ resolves the hostname and rejects non-public destinations (private, loopback, link-local and reserved addresses), non-HTTPS URLs, ports other than 443, embedded credentials and IP-literal hosts; it repeats these checks before every delivery attempt and disables the endpoint when one fails. Notifications cover changes committed after configuration; use the change feed to recover anything missed.
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/webhook-endpoint \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://hooks.example.com/paypathiq"
}
'Authorizations
Integration-owned environment-specific API key. Never paste a production key into documentation tools.
Path Parameters
Stable non-sensitive Client code authorized by the Integration grant.
^[A-Za-z0-9_-]{1,128}$Body
One uncompressed resource representation, limited to 256 KiB.
HTTPS URL that receives change notifications. It must use port 443, a public DNS name and no embedded credentials.
1 - 2048Response
The endpoint was updated. No signing secret is returned.
Why delivery stopped. Null while the endpoint is active. Configure the endpoint again after fixing the cause.
client_disabled, destination_unsafe, grant_revoked Increases each time the signing secret is rotated.
1 <= x <= 9007199254740991active, disabled Signing secret. Returned only when the endpoint is first configured or the secret is rotated; store it immediately.