Skip to content

Outbound Webhooks

Outbound Webhooks page showing a table with one webhook entry — description, URL, subscribed events, enabled state, and PSK field — with Edit, Test, and Delete row actions

Outbound Webhooks configures the HTTP endpoints Payment Nexus will notify when events occur on Payment Intent Tickets for this brand. Each webhook receives a signed POST request in real time as events happen.

Permissions

ActionPermission required
Manage outbound webhookstenant:manage:webhooks

Webhook table

ColumnDescription
DescriptionAn optional label to help identify the webhook's purpose
Webhook URLThe HTTP/HTTPS endpoint that receives the POST request
EventsThe event types this webhook is subscribed to
EnabledWhether the webhook is currently active
Pre-Shared KeyThe secret used to sign outgoing payloads (masked)

Row actions

ActionDescription
EditUpdate the webhook's configuration
TestSend a sample payload for every subscribed event and verify the endpoint returns a 2xx response
DeletePermanently remove the webhook

Adding a webhook

Click Add to create a new webhook.

FieldRequiredDescription
DescriptionNoA brief label to identify this webhook
Webhook URLYesThe HTTPS endpoint that will receive event notifications
Pre-Shared Key (PSK)YesA secret shared with the receiving endpoint, used to verify payload signatures
EventsYesOne or more event types to subscribe to (see below)
EnabledToggle to activate or deactivate this webhook; defaults to enabled

Available events

EventFires when
payment_intent_ticket.createdA new Payment Intent Ticket is created
payment_intent_ticket.updatedAn existing Payment Intent Ticket is updated
payment_intent_ticket.savedAny create or update occurs (fires alongside both of the above)

Payload and signature verification

Each delivery is a POST request with these headers:

HeaderDescription
X-Request-IDA unique UUID for this delivery
X-EventThe event type that triggered the delivery
X-TimestampISO 8601 UTC timestamp of the delivery
X-SignatureA bcrypt hash for verifying authenticity
User-AgentPayment Nexus/{VERSION} ({ENVIRONMENT})

To verify a delivery, reconstruct the pre-hash string {timestamp}|{psk}|{requestId}|{event} using the values from the headers and your stored PSK, then verify it against X-Signature using bcrypt. Checking the timestamp guards against replay attacks.

The payload body contains the Payment Intent Ticket data including ID, status, amount, currency, customer reference, and checkout details. For the full schema definition, refer to the Webhook Event Payload schema in the brand's API documentation.

TIP

Use the Test action after creating or editing a webhook to confirm your endpoint is reachable and responding correctly before relying on it for live events.

Click Refresh to reload the webhook list from the backend.