Skip to main content
POST
/
public
/
webhooks
Register webhook
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/public/webhooks \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "endpoint_url": "https://yourapp.com/webhooks/pcx"
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "webhook_id": "<string>",
    "org_id": "<string>",
    "endpoint_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Body

application/json
​
endpoint_url
string<uri>
required

HTTPS URL that PCX will POST transaction events to. Must be publicly reachable and return a 2xx response to acknowledge receipt.

Example:

"https://yourapp.com/webhooks/pcx"

Response

Webhook registered

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
​
data
object