Skip to main content
POST
Register webhook

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 events to. Must be publicly reachable and return a 2xx response to acknowledge receipt.

Example:

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

events
string[]

Event types to subscribe to. Omit or send an empty array to receive all event types. See GET /public/webhooks/events/catalogue for the full list.

Example:

Response

Webhook registered

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

"success"

message
string
data
object