Webhooks
Webhooks
The events, how they are delivered, and how retries work.
Adding a destination
Add one or more https addresses in Settings, Webhooks. Addresses must be public; private and local addresses are refused. The signing secret is shown once, when you add the address.
Events
| Event | When |
|---|---|
campaign_affiliate.activated | A creator joins a campaign or is accepted |
campaign_affiliate.removed | A creator is removed |
campaign_affiliate.left | A creator leaves |
campaign_affiliate.code_updated | A creator's code changes; tag is the new code and previous_tag the old one |
campaign_affiliate.<status> | Any other change of a creator's status |
affiliate_sale.created | A sale is credited to one of your creators |
sample_request.created, .approved, .rejected, .shipped, .delivered, .cancelled | A free sample you ship yourself is requested or moves on |
Delivery and retries
We send a POST with a JSON body and wait up to 10 seconds. Any 2xx answer counts as delivered; anything else is retried up to three times, after 1, 5 and 30 minutes. Delivery is at least once, so keep the idempotency_key values you have handled and skip repeats.