πŸ””Webhooks

Projects can configure webhook endpoints to receive real-time notifications when rewards are distributed. This lets you sync payout data with your own systems automatically.

When are webhooks triggered?

Webhooks fire when qualifying movements are created:

Movement type
Movement reason

point

end_user_payout or affiliate_payout

onchain-currency

end_user_payout or affiliate_payout

point

airdrop

onchain-currency

airdrop

Key features

Feature
Description

Real-time

Notifications sent as soon as qualifying movements are created

Automatic retries

Failed deliveries are retried automatically

Rate limiting

Built-in rate limiting to protect your endpoint

Delivery tracking

View delivery history and status via the API

Configuration

Webhooks are configured via the REST API. See the API documentationarrow-up-right for full details.

Endpoint
Method
Description

/v1/webhooks

POST

Create a webhook endpoint

/v1/webhooks

GET

List your webhook endpoints

/v1/webhooks/{id}

GET

Get a specific webhook

/v1/webhooks/{id}

PATCH

Update a webhook endpoint

/v1/webhooks/{id}

DELETE

Delete a webhook endpoint

/v1/webhooks/{id}/deliveries

GET

View delivery history

circle-info

Webhooks are currently only configurable via the REST API β€” webapp configuration is not yet available.

Last updated