Appearance
Webhooks
Webhooks let FairShare send real-time event updates to your system.
You can create a webhook by providing:
- A name
- A webhook URL
- The event you want to listen for
Webhooks are environment-specific, so sandbox webhooks only receive sandbox events, and live webhooks only receive live events.
If you move to live, you will need to set up your webhooks again in the live environment. For more details, see Sandbox vs Live.
Webhook Events
| Event | What it means |
|---|---|
contribution.created | A new contribution was created for a split session. |
split_session.created | A new split session was created. |
split_session.lead_authorized | The lead contributor's payment was successfully authorized. |
split_session.completed | The split session was successfully completed. |
split_session.partial | The split session has been partially funded but is not yet complete. |
split_session.expired | The split session expired before being completed. |
split_session.canceled | The split session was canceled. |
split_session.refunded | A completed split session was refunded. |
split_session.status_changed | The split session moved from one status to another. |
Signing Key
Each webhook includes a signing key. Store this securely and use it to verify that incoming webhook requests were sent by FairShare.
Delivery Attempts
After creating a webhook, you can view its delivery attempts in the dashboard.
For each attempt, FairShare shows:
- Time
- Event type
- Result
- HTTP status code
- Request body
- Response body
Recommended Flow
- Create the webhook in sandbox
- Test your endpoint
- Review delivery attempts
- Create the webhook again in live when ready