Webhooks

Webhook event types

Every Intrio webhook event, from referral created to payout paid, with a plain description of when it fires and an example JSON payload.

Available on Growth and above.

Subscribe each endpoint to the events it needs. Field values in these examples are illustrative.

EventWhen
partner.appliedSomeone applied through your public programme page. status is approved when applications are approved automatically (a partner.joined follows), otherwise pending until you review it.
partner.joinedA partner joined the programme: accepted an invite, or was approved from an application.
referral.createdA new referral was submitted by a partner, came in through a referral link, or was attributed from a tracked conversion.
referral.stage_changedA referral moved to a different pipeline stage.
referral.wonA referral was won: marked as won by an admin or converted by its first paid conversion.
conversion.recordedA sign-up, payment, order or refund was recorded through the Conversions API, the tracking tag, Stripe or a shop integration.
reward.createdA reward line was created for a partner. It may be held (building) or immediately payable.
reward.payableA reward became payable: the client paid, or the hold or return window passed.
reward.voidedA reward was voided, for example because the referral left Won or the payment was refunded.
payout.sentA payout was sent to a partner, by bank transfer or through Stripe.
reward.overdueA requested payout passed your stated payout terms without being paid. Sent at 7, 14 and 30 days overdue; days_overdue says which.
payment_report.createdA partner reported a payment problem with a reward or payout. Reply or resolve it from Payouts in your workspace.
pingA test event sent from the Webhooks page. Safe to ignore.

Partners#

partner.applied#

Someone applied through your public programme page. status is approved when applications are approved automatically (a partner.joined follows), otherwise pending until you review it.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "partner.applied",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "application": {
      "id": "cma_6p2w9k",
      "name": "Jane Smith",
      "email": "jane@smithadvisory.co.uk",
      "website": "https://smithadvisory.co.uk",
      "describes": "Consultant or adviser",
      "promotion": "Introductions to my clients",
      "status": "pending"
    }
  }
}

partner.joined#

A partner joined the programme: accepted an invite, or was approved from an application.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "partner.joined",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    },
    "tier": "Bronze"
  }
}

Referrals#

referral.created#

A new referral was submitted by a partner, came in through a referral link, or was attributed from a tracked conversion.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "referral.created",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "referral": {
      "id": "cmr_4h7d0q",
      "programme": "intro",
      "stage": "New",
      "external_customer_id": "cus_9921",
      "company": "Acme Ltd"
    },
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    },
    "source": "portal"
  }
}

referral.stage_changed#

A referral moved to a different pipeline stage.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "referral.stage_changed",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "referral": {
      "id": "cmr_4h7d0q",
      "programme": "intro",
      "stage": "Proposal sent",
      "external_customer_id": "cus_9921",
      "company": "Acme Ltd"
    },
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    },
    "previous_stage": "Qualified"
  }
}

referral.won#

A referral was won: marked as won by an admin or converted by its first paid conversion.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "referral.won",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "referral": {
      "id": "cmr_4h7d0q",
      "programme": "intro",
      "stage": "Won",
      "external_customer_id": "cus_9921",
      "company": "Acme Ltd"
    },
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    },
    "value": 1200000,
    "currency": "GBP"
  }
}

Conversions#

conversion.recorded#

A sign-up, payment, order or refund was recorded through the Conversions API, the tracking tag, Stripe or a shop integration.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "conversion.recorded",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "conversion": {
      "id": "inv_1001",
      "type": "payment",
      "status": "recorded",
      "amount": 4900,
      "currency": "GBP"
    },
    "referral": {
      "id": "cmr_4h7d0q",
      "programme": "intro",
      "stage": "Won",
      "external_customer_id": "cus_9921",
      "company": "Acme Ltd"
    },
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    }
  }
}

Rewards#

reward.created#

A reward line was created for a partner. It may be held (building) or immediately payable.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "reward.created",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "reward": {
      "id": "cmw_2n6s3p",
      "amount": 15000,
      "currency": "GBP",
      "state": "building",
      "referral_id": "cmr_4h7d0q",
      "partner_id": "cmp_8f2k1x"
    }
  }
}

reward.payable#

A reward became payable: the client paid, or the hold or return window passed.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "reward.payable",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "reward": {
      "id": "cmw_2n6s3p",
      "amount": 15000,
      "currency": "GBP",
      "state": "payable",
      "referral_id": "cmr_4h7d0q",
      "partner_id": "cmp_8f2k1x"
    }
  }
}

reward.voided#

A reward was voided, for example because the referral left Won or the payment was refunded.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "reward.voided",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "reward": {
      "id": "cmw_2n6s3p",
      "amount": 15000,
      "currency": "GBP",
      "state": "void",
      "referral_id": "cmr_4h7d0q",
      "partner_id": "cmp_8f2k1x"
    },
    "reason": "Referral moved to Lost"
  }
}

Payouts#

payout.sent#

A payout was sent to a partner, by bank transfer or through Stripe.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "payout.sent",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "payout": {
      "id": "cmo_7t1v5c",
      "amount": 45000,
      "currency": "GBP",
      "partner_id": "cmp_8f2k1x",
      "reward_ids": [
        "cmw_2n6s3p",
        "cmw_8k3m1z"
      ]
    },
    "method": "manual",
    "reference": "BACS 0412",
    "partner": {
      "id": "cmp_8f2k1x",
      "code": "jane-a1b2",
      "name": "Jane Smith",
      "company": "Smith Advisory"
    }
  }
}

Payout assurance#

reward.overdue#

A requested payout passed your stated payout terms without being paid. Sent at 7, 14 and 30 days overdue; days_overdue says which.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "reward.overdue",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "payout": {
      "id": "cmo_7t1v5c",
      "amount": 45000,
      "currency": "GBP",
      "partner_id": "cmp_8f2k1x",
      "reward_ids": [
        "cmw_2n6s3p"
      ]
    },
    "days_overdue": 7,
    "overdue_since": "2026-11-13T10:15:00.000Z",
    "terms_days": 30
  }
}

payment_report.created#

A partner reported a payment problem with a reward or payout. Reply or resolve it from Payouts in your workspace.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "payment_report.created",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "report": {
      "id": "cmpr_1x9d4f",
      "reason": "not_paid",
      "amount": 45000,
      "currency": "GBP",
      "partner_id": "cmp_8f2k1x",
      "reward_id": null,
      "payout_id": "cmo_7t1v5c"
    }
  }
}

Test#

ping#

A test event sent from the Webhooks page. Safe to ignore.

JSON
{
  "id": "evt_3Jf9xQ2mZr8LkP0aT1sW",
  "type": "ping",
  "created_at": "2026-11-20T10:15:00.000Z",
  "api_version": "2026-11-20",
  "workspace": {
    "id": "cmws_5q8r2t",
    "slug": "acme"
  },
  "data": {
    "message": "Test event from Intrio"
  }
}

Last updated 20 November 2026. Building with an AI assistant? Point it at /docs/llms-full.txt.