---
title: "referral.received"
method: POST
path: "referral.received"
---

# referral.received

`POST referral.received` (webhook)

A participant entered a DM thread via an ig.me / m.me link (Facebook & Instagram).

## Payload

- WebhookEventReferral: Envelope shared by every webhook delivery.
  - `id` string, required: Delivery ID, prefixed with whevt_. Matches the X-Postproxy-Delivery header.
  - `object` 'event', required: Always "event".
  - `type` string, required: Event type (e.g. platform_post.published). Matches the X-Postproxy-Event header.
  - `created_at` string, required: ISO 8601 timestamp of when the event was generated.
  - `data` object, required: Container for the event-specific resource.
    - `object` object: Referral payload - a participant entered a DM thread via an ig.me / m.me link carrying a ref parameter. Facebook & Instagram only.
      - `chat` object: The full chat object, with the referral already stored under metadata.referral.
      - `ref` string: The ref parameter from the link.
      - `source` string: Where the referral came from (e.g. SHORTLINK).
      - `type` string: Meta's referral type (e.g. OPEN_THREAD).
      - `occurred_at` string, nullable: ISO 8601 time the referral occurred.

## Acknowledgement `200`

Acknowledged

---

[API](https://skmtc.dev/postproxy/apis/postproxy-social-media-api.md) - [All operations](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/llms.txt) - [OpenAPI document](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/revisions/d54482ac4ce7?raw)