Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Webhooks

A Webhook delivers an HTTP POST to a URL you control whenever one of the subscribed events happens on your account. Webhooks are account-scoped and fully manageable through the API — list, retrieve, create, update, and delete.

Subscribable events: new_referral, reward_unlocked, reward_redeemed, sync_subscriber, new_partner_referral, new_partner_pending_referral, new_opportunity. (new_offer_lead is read-only — it's tied to an offer and managed in the dashboard.)

List webhooks

GET https://api.sparkloop.app/v3/webhooks

Paginated.

{
  "webhooks": [
    <Webhook Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 1,
    "total_webhooks": 3
  }
}

Get webhook

GET https://api.sparkloop.app/v3/webhooks/:uuid

Path Parameters

Name
Type
Description

uuid*

String

The webhook's UUID.

Create webhook

POST https://api.sparkloop.app/v3/webhooks

Request Body

Name
Type
Description

url*

String

The destination URL. Must be https.

events

Array

The event names to enable.

Update webhook

PUT https://api.sparkloop.app/v3/webhooks/:uuid

Supplying events replaces the whole set; omit it to change url alone.

Path Parameters

Name
Type
Description

uuid*

String

The webhook's UUID.

Request Body

Name
Type
Description

url

String

The destination URL. Must be https.

events

Array

Replacement set of event names.

Delete webhook

DELETE https://api.sparkloop.app/v3/webhooks/:uuid

Path Parameters

Name
Type
Description

uuid*

String

The webhook's UUID.

PreviousPayoutsNextObjects Schema