Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OptinEvent

OptinEvent occurs when the send to Messenger plugin has been tapped, a user has accepted a message request using customer matching, or a user has opted in to receive messages via the checkbox plugin.

subscription

messaging_optins

guides

Check official reference.

Hierarchy

Index

Properties

[toStringTag]: "MessengerEvent"
category: "postback"
dataRef: string

The data-ref attribute that was defined with the entry point.

isEcho: boolean

Indicate whether the event is an echo.

isStandby: boolean

Indicate whether the event is sent to a standby channel.

payload: any
platform: "messenger"

The user that triggered the webhook event.

timestamp: number
type: "optin"
user: null | MessengerUser
userRef: undefined | string

Checkbox plugin only. user_ref attribute that was defined in the checkbox plugin include.

Generated using TypeDoc