Sync data with webhooks

What you’ll build

Before you start, make sure you have the following in place:

• A Paycux account with access to the project you are configuring.
• An API key for the environment you are working in. Staging keys start with sk_test_; production keys start with sk_live_.
• Admin access on the system you are connecting, so you can create the application and read its metadata.
• A redirect URI registered in the Paycux dashboard under Developer → Redirects.

Set up your webhook endpoint

Webhooks deliver each event to your endpoint over HTTPS with a signature header. Verify the signature before you trust the body, and respond with a 2xx status within thirty seconds.

Delivery is at-least-once, so make your handler idempotent — key it on the event ID and ignore an ID you have already processed. Failed deliveries retry with exponential backoff for twenty-four hours.

Register your endpoint

Register your endpoint is handled by Sync data with webhooks rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Process the events

Process the events is handled by Sync data with webhooks rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Respond with HTTP 200 OK

Respond with HTTP 200 OK is handled by Sync data with webhooks rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

AValidate the requests using the SDK

Official SDKs are published for Node.js, Python, Ruby, Go, PHP, Java and .NET. They share the same method names, so a snippet translates between languages with little more than syntax changes.

Each SDK reads PAYCUX_API_KEY from the environment by default and retries idempotent requests on transport errors.

BValidate the requests manually

BValidate the requests manually is handled by Sync data with webhooks rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Create an IP allowlist

Create an IP allowlist is handled by Sync data with webhooks rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.