Skip to main content
Work in progress, under review. This page is not validated yet and may contain inaccuracies. Track and record its status in the documentation review tracker. This banner is removed once the page is validated.
Webhooks let Paylead push notifications to your back-office the moment something happens on your Program: a Reward is created, a Consumer’s scraping fails, an Offer is about to expire. From Shift, you declare which URL receives each event type and inspect the dispatch history.
This page covers the Shift workflow: how to register a callback URL, test it, and audit deliveries. For the technical contract (payload shape, signature, retry policy, idempotency), see the Webhooks concept.

​
Set up a Webhook

Each event type is configured independently. You point each event at a single callback URL on your side.
1

Open the Hooks section

In Shift, go to My Account > Developers > Hooks. The left side lists every event type Paylead supports.
2

Pick the event you want to subscribe to

Click the + next to the event. Its configuration panel opens on the right.
3

Enter the callback URL

In the Callback URL field, enter the HTTPS endpoint that will receive the event. The endpoint must accept POST with a JSON body and respond 2xx quickly.
4

Validate with a test delivery

Click Send test. Paylead immediately posts a payload to the URL with mock data; non-nullable fields are populated with sample values, nullable fields are left blank. Use this to confirm DNS, TLS, and your handler’s basic plumbing.
5

Save your changes

Click Save. The Webhook is now live and Paylead will dispatch real events to it from this moment forward.
To remove a Webhook, click the trash icon next to the event in the Hooks list.

​
Available events

Paylead emits Webhooks across four families: the Reward lifecycle, the Affiliation lifecycle, payouts, and Offer changes. Subscribe only to the events your back-office actually reacts to.

​
Reward lifecycle

​
Affiliation lifecycle

​
Payouts and Ventilation

​
Offers

​
Bank synchronization

The Scraping Error Webhook fires when the Consumer’s account enters any of the following synchronization statuses:
  • SCARequired, webauthRequired, additionalInformationNeeded, decoupled, validating: the sync is suspended. Resetting it requires the Consumer to renew consent or complete an SCA (Strong Customer Authentication) flow.
  • ActionNeeded: the Consumer must perform a specific action on the bank’s website or app (for example, accept new terms and conditions).
See the Status reference for the full synchronization status list.

​
Event logs

The Event Logs tab in My Account > Developers lists every Webhook delivery attempted on your Program. Use it to audit failures and confirm that your endpoint is up. Use the Date from and Date to filters to scope the history. Without filters, every event since the Program launched is shown.
Each delivery includes a unique event_id. Persist it on your side and dedupe on it; Paylead may redeliver the same event after retries. See idempotency for the recommended pattern.

​
What’s next

Webhooks concept

Payload shape, HMAC signature verification, and retry policy for your endpoint.

API keys

Generate the Connector, Injector, and M2M credentials your back-office needs.

Status reference

Canonical list of every status Shift exposes, including synchronization codes.

Ventilations and invoices

Download Ventilation files once the Ventilation File Available event fires.