Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReferralEvent

This callback will occur when the user already has a thread with the bot and user comes to the thread from:

  • Following an m.me link with a referral parameter
  • Clicking on a Messenger Conversation Ad
  • Starting or resuming a conversation from the customer chat plugin.

For tracking referrals in new threads, refer to PostbackEvent.

subscription

messaging_referrals

guides

Check official reference.

Hierarchy

Index

Properties

Properties

Readonly [toStringTag]

[toStringTag]: "MessengerEvent"

Readonly adId

adId: undefined | string

Id of ad if source is 'ADS'

category

category: "action"

channel

channel: MessengerChat | MessengerSendTarget

Readonly isEcho

isEcho: boolean

Indicate whether the event is an echo.

Readonly isGuestUser

isGuestUser: boolean

A flag indicating whether the user is a guest user from Facebook Chat Plugin.

Readonly isStandby

isStandby: boolean

Indicate whether the event is sent to a standby channel.

payload

payload: any

Readonly platform

platform: "messenger"

Readonly ref

ref: string

The optional ref attribute set in the referrer.

Readonly refererUri

refererUri: undefined | string

The URI of the site where the message was sent in the Facebook chat plugin.

Readonly sender

sender: PSIDTarget | UserRefTarget

The user that triggered the webhook event.

Readonly source

source: ReferralSource

The source of the referral.

Readonly timestamp

timestamp: number

type

type: "referral"

user

user: null | MessengerUser

Generated using TypeDoc