dist¶

Interfaces¶

MessengerApiResponse¶

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

attachment_id?¶

optional attachment_id?: string;

message_id?¶

optional message_id?: string;

recipient_id?¶

optional recipient_id?: string;

MessengerChallengeVerificationInput¶

Properties¶

challenge?¶

optional challenge?: string;

expectedVerifyToken¶

expectedVerifyToken: string;

mode?¶

optional mode?: string;

token?¶

optional token?: string;

MessengerConversationResponse¶

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

data?¶

optional data?: MessengerSocialJsonObject[];

paging?¶

optional paging?: MessengerSocialJsonObject;

MessengerConversationSearchInput¶

Properties¶

after?¶

optional after?: string;

fields?¶

optional fields?: string[];

limit?¶

optional limit?: number;

userId?¶

optional userId?: string;

MessengerCredentialStatusInput¶

Properties¶

appSecret?¶

optional appSecret?: string;

expiresAt?¶

optional expiresAt?: string;

pageAccessToken?¶

optional pageAccessToken?: string;

pageId?¶

optional pageId?: string;

pageWebhookSubscribed?¶

optional pageWebhookSubscribed?: boolean;

scopes?¶

optional scopes?: string[];

verifyToken?¶

optional verifyToken?: string;

MessengerHandoverInput¶

Properties¶

metadata?¶

optional metadata?: string;

recipientId¶

recipientId: string;

targetAppId?¶

optional targetAppId?: string;

MessengerLiveCheckOptions¶

Extends¶

MessengerSocialClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

MessengerSocialClientOptions.accessToken

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

MessengerSocialClientOptions.baseUrl

client?¶

optional client?: Pick<MessengerSocialClient, "listConversations" | "getPage">;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

MessengerSocialClientOptions.fetch

graphApiBaseUrl?¶

optional graphApiBaseUrl?: string;

Inherited from¶

MessengerSocialClientOptions.graphApiBaseUrl

graphApiVersion?¶

optional graphApiVersion?: string;

Inherited from¶

MessengerSocialClientOptions.graphApiVersion

pageAccessToken?¶

optional pageAccessToken?: string;

Inherited from¶

MessengerSocialClientOptions.pageAccessToken

pageId?¶

optional pageId?: string;

Inherited from¶

MessengerSocialClientOptions.pageId

providerClient?¶

optional providerClient?: MessengerSocialProviderClient;

Inherited from¶

MessengerSocialClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from¶

MessengerSocialClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

MessengerSocialClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

MessengerSocialClientOptions.timeoutMs

MessengerProviderHandoverInput¶

Extends¶

MessengerSocialJsonObject

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

metadata?¶

optional metadata?: string;

recipient¶

recipient: {
  id: string;
};

id¶

id: string;

target_app_id?¶

optional target_app_id?: string;

MessengerProviderSendMessageInput¶

Extends¶

MessengerSocialJsonObject

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

message?¶

optional message?: MessengerSocialJsonObject;

messaging_type¶

messaging_type: NonNullable<"RESPONSE" | "UPDATE" | "MESSAGE_TAG">;

notification_type?¶

optional notification_type?: NonNullable<"REGULAR" | "SILENT_PUSH" | "NO_PUSH">;

recipient¶

recipient: {
  id: string;
};

id¶

id: string;

sender_action?¶

optional sender_action?: NonNullable<"typing_on" | "typing_off" | "mark_seen">;

tag?¶

optional tag?: string;

MessengerProviderUploadAttachmentInput¶

Extends¶

MessengerSocialJsonObject

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

message¶

message: {
  attachment: {
     payload: {
        is_reusable: boolean;
        url: string;
     };
     type: MessengerAttachmentType;
  };
};

attachment¶

attachment: {
  payload: {
     is_reusable: boolean;
     url: string;
  };
  type: MessengerAttachmentType;
};

attachment.payload¶

payload: {
  is_reusable: boolean;
  url: string;
};

attachment.payload.is_reusable¶

is_reusable: boolean;

attachment.payload.url¶

url: string;

attachment.type¶

type: MessengerAttachmentType;

MessengerSendMessageInput¶

Properties¶

additionalFields?¶

optional additionalFields?: MessengerSocialProviderExtensionFields;

message?¶

optional message?: MessengerSocialJsonObject;

messagingType?¶

optional messagingType?: "RESPONSE" | "UPDATE" | "MESSAGE_TAG";

notificationType?¶

optional notificationType?: "REGULAR" | "SILENT_PUSH" | "NO_PUSH";

recipient¶

recipient: {
  id: string;
};

id¶

id: string;

senderAction?¶

optional senderAction?: "typing_on" | "typing_off" | "mark_seen";

tag?¶

optional tag?: string;

MessengerSocialClient¶

Properties¶

providerClient¶

providerClient: MessengerSocialProviderClient;

Methods¶

getConversationMessages()¶

getConversationMessages(conversationId, input?): Promise<MessengerConversationResponse>;

Parameters¶

Parameter	Type
`conversationId`	`string`
`input?`	`Omit`\<`MessengerConversationSearchInput`, `"userId"`>

Returns¶

Promise\<MessengerConversationResponse>

getPage()¶

getPage(): Promise<MessengerSocialProviderResponse>;

Returns¶

Promise\<MessengerSocialProviderResponse>

listConversations()¶

listConversations(input?): Promise<MessengerConversationResponse>;

Parameters¶

Parameter	Type
`input?`	`MessengerConversationSearchInput`

Returns¶

Promise\<MessengerConversationResponse>

passThreadControl()¶

passThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerHandoverInput` & { `targetAppId`: `string`; }

Returns¶

Promise\<MessengerApiResponse>

requestThreadControl()¶

requestThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`Omit`\<`MessengerHandoverInput`, `"targetAppId"`>

Returns¶

Promise\<MessengerApiResponse>

sendMessage()¶

sendMessage(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerSendMessageInput`

Returns¶

Promise\<MessengerApiResponse>

sendSenderAction()¶

sendSenderAction(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	{ `action`: `NonNullable`\<`"typing_on"` \| `"typing_off"` \| `"mark_seen"`>; `recipientId`: `string`; }
`input.action`	`NonNullable`\<`"typing_on"` \| `"typing_off"` \| `"mark_seen"`>
`input.recipientId`	`string`

Returns¶

Promise\<MessengerApiResponse>

sendText()¶

sendText(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	{ `messagingType?`: `"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`; `recipientId`: `string`; `tag?`: `string`; `text`: `string`; }
`input.messagingType?`	`"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`
`input.recipientId`	`string`
`input.tag?`	`string`
`input.text`	`string`

Returns¶

Promise\<MessengerApiResponse>

takeThreadControl()¶

takeThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`Omit`\<`MessengerHandoverInput`, `"targetAppId"`>

Returns¶

Promise\<MessengerApiResponse>

uploadAttachment()¶

uploadAttachment(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerUploadAttachmentInput`

Returns¶

Promise\<MessengerApiResponse>

MessengerSocialClientOptions¶

Extended by¶

MessengerLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

baseUrl?¶

optional baseUrl?: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

graphApiBaseUrl?¶

optional graphApiBaseUrl?: string;

graphApiVersion?¶

optional graphApiVersion?: string;

pageAccessToken?¶

optional pageAccessToken?: string;

pageId?¶

optional pageId?: string;

providerClient?¶

optional providerClient?: MessengerSocialProviderClient;

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

MessengerSocialJsonObject¶

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

MessengerSocialProviderClient¶

Methods¶

getConversationMessages()¶

getConversationMessages(conversationId, input?): Promise<MessengerConversationResponse>;

Parameters¶

Parameter	Type
`conversationId`	`string`
`input?`	`Omit`\<`MessengerConversationSearchInput`, `"userId"`>

Returns¶

Promise\<MessengerConversationResponse>

getPage()¶

getPage(): Promise<MessengerSocialProviderResponse>;

Returns¶

Promise\<MessengerSocialProviderResponse>

listConversations()¶

listConversations(input?): Promise<MessengerConversationResponse>;

Parameters¶

Parameter	Type
`input?`	`MessengerConversationSearchInput`

Returns¶

Promise\<MessengerConversationResponse>

passThreadControl()¶

passThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerProviderHandoverInput`

Returns¶

Promise\<MessengerApiResponse>

requestThreadControl()¶

requestThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerProviderHandoverInput`

Returns¶

Promise\<MessengerApiResponse>

sendMessage()¶

sendMessage(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerProviderSendMessageInput`

Returns¶

Promise\<MessengerApiResponse>

takeThreadControl()¶

takeThreadControl(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerProviderHandoverInput`

Returns¶

Promise\<MessengerApiResponse>

uploadAttachment()¶

uploadAttachment(input): Promise<MessengerApiResponse>;

Parameters¶

Parameter	Type
`input`	`MessengerProviderUploadAttachmentInput`

Returns¶

Promise\<MessengerApiResponse>

MessengerSocialProviderExtensionFields¶

Extends¶

MessengerSocialJsonObject

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

MessengerSocialProviderResponse¶

Extends¶

MessengerSocialJsonObject

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

MessengerUploadAttachmentInput¶

Properties¶

isReusable?¶

optional isReusable?: boolean;

type¶

type: MessengerAttachmentType;

url¶

url: string;

MessengerWebhookPayload¶

Indexable¶

[key: string]: MessengerSocialProviderExtensionValue

Properties¶

entry?¶

optional entry?: {
[key: string]: MessengerSocialProviderExtensionValue;
  changes?: MessengerSocialJsonObject[];
  id?: string;
  messaging?: MessengerSocialJsonObject[];
  time?: number;
}[];

Index Signature¶

[key: string]: MessengerSocialProviderExtensionValue

changes?¶

optional changes?: MessengerSocialJsonObject[];

id?¶

optional id?: string;

messaging?¶

optional messaging?: MessengerSocialJsonObject[];

time?¶

optional time?: number;

object?¶

optional object?: string;

ParseMessengerWebhookOptions¶

Properties¶

appSecret?¶

optional appSecret?: string;

rawBody?¶

optional rawBody?: string;

requireSignature?¶

optional requireSignature?: boolean;

Type Aliases¶

MessengerAttachmentType¶

type MessengerAttachmentType = "image" | "audio" | "video" | "file";

MessengerNormalizedEvent¶

type MessengerNormalizedEvent = {
  message: MessengerSocialJsonObject;
  provider: "messenger";
  raw: MessengerSocialJsonObject;
  type: "social.message.received";
};

Properties¶

message¶

message: MessengerSocialJsonObject;

provider¶

provider: "messenger";

raw¶

raw: MessengerSocialJsonObject;

type¶

type: "social.message.received";

MessengerSocialJsonPrimitive¶

type MessengerSocialJsonPrimitive = string | number | boolean | null;

MessengerSocialJsonValue¶

type MessengerSocialJsonValue =
  | MessengerSocialJsonPrimitive
  | MessengerSocialJsonObject
  | readonly MessengerSocialJsonValue[];

MessengerSocialProviderExtensionValue¶

type MessengerSocialProviderExtensionValue =
  | MessengerSocialJsonValue
  | object
  | undefined;

MessengerSocialProviderPayload¶

type MessengerSocialProviderPayload = MessengerSocialJsonObject | object;

MessengerSocialProviderQuery¶

type MessengerSocialProviderQuery = Record<string, MessengerSocialProviderExtensionValue>;

Functions¶

createMessengerAttachmentMessage()¶

function createMessengerAttachmentMessage(input): MessengerSendMessageInput;

Parameters¶

Parameter	Type
`input`	{ `messagingType?`: `"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`; `payload`: `MessengerSocialProviderPayload`; `recipientId`: `string`; `tag?`: `string`; `type`: `"template"` \| `MessengerAttachmentType`; }
`input.messagingType?`	`"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`
`input.payload`	`MessengerSocialProviderPayload`
`input.recipientId`	`string`
`input.tag?`	`string`
`input.type`	`"template"` \| `MessengerAttachmentType`

Returns¶

MessengerSendMessageInput

createMessengerGraphProviderClient()¶

function createMessengerGraphProviderClient(options): MessengerSocialProviderClient;

Parameters¶

Parameter	Type
`options`	`MessengerSocialClientOptions`

Returns¶

MessengerSocialProviderClient

createMessengerSocialClient()¶

function createMessengerSocialClient(options?): MessengerSocialClient;

Parameters¶

Parameter	Type
`options?`	`MessengerSocialClientOptions`

Returns¶

MessengerSocialClient

createMessengerSocialLiveChecks()¶

function createMessengerSocialLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        category: string;
        id: string;
        name: string;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`MessengerLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { category: string; id: string; name: string; }; }>; }[]

createMessengerTextMessage()¶

function createMessengerTextMessage(input): MessengerSendMessageInput;

Parameters¶

Parameter	Type
`input`	{ `messagingType?`: `"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`; `recipientId`: `string`; `tag?`: `string`; `text`: `string`; }
`input.messagingType?`	`"RESPONSE"` \| `"UPDATE"` \| `"MESSAGE_TAG"`
`input.recipientId`	`string`
`input.tag?`	`string`
`input.text`	`string`

Returns¶

MessengerSendMessageInput

defineMessengerSocialIntegration()¶

function defineMessengerSocialIntegration(options): DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: readonly [{
     audiences: readonly ["customer-facing", "mixed"];
     capability: "receive";
     description: "Validates and parses Messenger Platform webhook payloads after the SDK user's Page is subscribed to the messages webhook.";
     exposesSensitiveData: true;
     label: "Receive Messenger webhooks";
     providerObjects: readonly [{
        kind: "messengerWebhook";
        label: "Messenger Webhook";
      }, {
        kind: "messengerMessage";
        label: "Messenger Message";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing"];
     capability: "send";
     description: "Sends Messenger Platform messages inside Meta's 24-hour standard messaging window or with SDK-user-approved MESSAGE_TAG non-promotional policy where permitted.";
     exposesSensitiveData: true;
     label: "Send Messenger messages";
     providerObjects: readonly [{
        kind: "messengerMessage";
        label: "Messenger Message";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "draft";
     description: "Builds text, attachment, quick reply, sender action, and tag payloads for SDK-user approval workflows.";
     exposesSensitiveData: true;
     label: "Build Messenger payloads";
     providerObjects: readonly [{
        kind: "messengerDraft";
        label: "Messenger Draft";
     }];
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "thread";
     description: "Reads Messenger conversation and message metadata through the configured Meta SDK-backed Graph adapter or provider client with SDK-user-governed access and retention.";
     exposesSensitiveData: true;
     label: "Use Messenger conversations";
     providerObjects: readonly [{
        kind: "messengerConversation";
        label: "Messenger Conversation";
      }, {
        kind: "messengerMessage";
        label: "Messenger Message";
      }, {
        kind: "messengerPage";
        label: "Messenger Page";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "read-provider-object";
     description: "Reads Messenger conversation messages and metadata through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     label: "Read Messenger conversations";
     providerObjects: readonly [{
        kind: "messengerConversation";
        label: "Messenger Conversation";
      }, {
        kind: "messengerMessage";
        label: "Messenger Message";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "search-provider-object";
     description: "Lists Messenger Page conversations through the configured Meta SDK-backed Graph adapter or provider client with SDK-user-supplied filters such as user ID, fields, limits, and cursors.";
     exposesSensitiveData: true;
     label: "List Messenger conversations";
     providerObjects: readonly [{
        kind: "messengerConversation";
        label: "Messenger Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "media";
     description: "Sends attachment payloads and exposes inbound attachment metadata under SDK-user media policy.";
     exposesSensitiveData: true;
     label: "Use Messenger attachments";
     providerObjects: readonly [{
        kind: "messengerAttachment";
        label: "Messenger Attachment";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "social.webhook-signature";
     description: "Validates X-Hub-Signature-256 webhook signatures with the SDK user's Meta app secret.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Meta webhook signatures";
     providerObjects: readonly [{
        kind: "messengerSignedWebhook";
        label: "Messenger Signed Webhook";
     }];
     requiresCredential: true;
  }];
  category: "social";
  channelAudiences: readonly ["customer-facing", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Messenger webhooks";
        url: "https://developers.facebook.com/documentation/business-messaging/messenger-platform/webhooks";
      }, {
        label: "Page subscribed apps";
        url: "https://developers.facebook.com/docs/graph-api/reference/page/subscribed_apps/";
      }, {
        label: "Messenger Send API";
        url: "https://developers.facebook.com/docs/messenger-platform/send-messages/message-tags";
      }, {
        label: "Messenger sender actions";
        url: "https://developers.facebook.com/docs/messenger-platform/send-messages/sender-actions";
      }, {
        label: "Messenger attachment upload";
        url: "https://developers.facebook.com/docs/messenger-platform/reference/attachment-upload-api";
      }, {
        label: "Messenger conversation routing";
        url: "https://developers.facebook.com/documentation/business-messaging/messenger-platform/conversation-routing";
      }, {
        label: "Meta Business SDK for NodeJS";
        url: "https://github.com/facebook/facebook-nodejs-business-sdk";
     }];
     notes: readonly ["Coverage is typed for selected Messenger Platform support workflows: Page messages send, text payloads, sender actions, attachment payload/upload helpers, conversation/message reads, Page readiness, webhook challenge handling, and X-Hub-Signature-256 validation.", "Runtime provider operations use Meta's facebook-nodejs-business-sdk when credentials are configured; hosts may inject a Messenger/Meta provider client override.", "Meta's current Messenger routing surface is Conversation Routing; deprecated Handover Protocol thread-control helpers are not advertised as a current handoff capability by this package.", "This is not full Messenger Platform coverage; Messenger profile, persistent menu, personas, discovery and engagement tools, account linking, NLP, analytics, marketing messages, conversation routing configuration, and broader Page/Graph administration remain outside this adapter."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Optional SDK-user-owned provider client implementing MessengerSocialProviderClient for Messenger Platform and selected Meta Graph operations.";
     id: "messenger-provider-client";
     label: "Messenger/Meta provider client override";
     metadata: {
        defaultClientPolicy: "facebook-nodejs-business-sdk-when-configured";
        importPolicy: "provider-client-override-supported";
        interface: "MessengerSocialProviderClient";
     };
     required: false;
   }, {
     description: "Server-side Meta Page access token used by the Meta SDK-backed Graph adapter or an injected Messenger/Meta provider client.";
     id: "messenger-page-access-token";
     label: "Messenger Page access token";
     metadata: {
        scopeKind: "provider-permission-labels";
     };
     required: true;
     scopes: readonly ["pages_messaging", "pages_show_list", "pages_read_engagement", "pages_manage_metadata"];
   }, {
     description: "Page ID that owns the Messenger inbox and conversation graph.";
     id: "messenger-page-id";
     label: "Facebook Page ID";
     required: true;
   }, {
     description: "Server-side app secret used to validate X-Hub-Signature-256 webhook deliveries.";
     id: "messenger-app-secret";
     label: "Meta app secret";
     required: true;
   }, {
     description: "SDK-user-owned token checked during Meta webhook endpoint verification.";
     id: "messenger-webhook-verify-token";
     label: "Webhook verify token";
     required: false;
   }, {
     description: "SDK-user-confirmed Page subscribed_apps configuration for Messenger messages webhooks.";
     id: "messenger-page-webhook-subscription";
     label: "Messenger Page messages webhook subscription";
     required: false;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "social.messenger";
  limitations: readonly ["Available operations depend on the SDK user's Meta app mode, Page connection, permissions, Page access token, webhook subscriptions, and messaging window rules.", "Meta no longer supports Handover Protocol as the normal Messenger routing model; SDK users should configure Conversation Routing outside this adapter, and the thread-control client methods are deprecated provider escape hatches only.", "Consent, outbound-contact policy, human escalation, attachment retention, redaction, and deletion behavior remain SDK-user configuration.", "This package provides Messenger payload/webhook helpers and does not choose default automation, promotional messaging, retry, HTTP transport, or rate-limit policy."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     apiCoverage: {
        checkedAt: "2026-06-25";
        fullMetaGraphCoverage: false;
        fullProviderApi: false;
        generatedFromOfficialSpec: false;
        implementedOperationCount: 8;
        machineReadableSpecStatus: "No official public complete Messenger Platform/Graph OpenAPI spec was found in facebook/openapi during this audit.";
        operationCatalog: "docs/provider-coverage/messenger-platform-graph-selected-api-2026-06-18.operations.json";
        selectedOperationCount: 8;
     };
     channelCoverage: {
        attachments: "facebook-nodejs-business-sdk-call";
        conversationRouting: "provider-supported-not-typed";
        conversations: "facebook-nodejs-business-sdk-call";
        customTransportFallback: "package-owned-rest-adapter";
        handoverProtocolThreadControl: "provider-supported-deprecated-typed-thread-control";
        messages: "facebook-nodejs-business-sdk-call";
        pageReadiness: "facebook-nodejs-business-sdk-call";
        senderActions: "facebook-nodejs-business-sdk-call";
        webhooks: "typed-challenge-verify-parse";
     };
     docs: "https://developers.facebook.com/docs/messenger-platform";
     implementation: {
        allowedOperations: readonly [{
           alias: "messenger.webhook.parse";
           checksum: "not-applicable-local-helper";
           id: "parseMessengerWebhook";
           source: "local-webhook-parser";
           target: "package.webhooks.parseMessengerWebhook";
         }, {
           alias: "messenger.message.send";
           checksum: "not-applicable-rest-adapter";
           id: "sendMessage";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.senderAction.send";
           checksum: "not-applicable-rest-adapter";
           id: "sendSenderAction";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.attachment.upload";
           checksum: "not-applicable-rest-adapter";
           id: "uploadAttachment";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.conversations.list";
           checksum: "not-applicable-rest-adapter";
           id: "listConversations";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.conversationMessages.list";
           checksum: "not-applicable-rest-adapter";
           id: "getConversationMessages";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.page.read";
           checksum: "not-applicable-rest-adapter";
           id: "getPage";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "messenger.webhook-signature";
           checksum: "not-applicable-local-helper";
           id: "validateMessengerWebhookSignature";
           source: "local-signature-helper";
           target: "package.webhooks.validateMessengerWebhookSignature";
        }];
        implementationStrategy: "provider-sdk-default-with-typed-domain-adapter";
        providerSdk: {
           license: "Platform License";
           package: "facebook-nodejs-business-sdk";
           runtimeCall: "FacebookAdsApi.call";
           runtimeEntry: "FacebookAdsApi";
           version: "24.0.1";
        };
        sdkDecision: "Meta's maintained facebook-nodejs-business-sdk@24.0.1 is provider-owned and exposes FacebookAdsApi.call(method, path, params). This package maps its strict Messenger support slice onto that SDK call surface by default; the package-owned REST adapter is retained only for explicit custom transport options such as fetch, graphApiBaseUrl, graphApiVersion, signal, timeoutMs, or retry.";
        verifiedAt: "2026-06-25";
     };
     manifestOnlySafe: true;
     providerClient: {
        customTransportFallbackPolicy: "package-owned-rest-adapter-for-fetch-base-version-signal-timeout-retry";
        defaultClientPolicy: "facebook-nodejs-business-sdk-when-configured";
        importPolicy: "provider-client-override-supported";
        interface: "MessengerSocialProviderClient";
        package: "facebook-nodejs-business-sdk-or-host-provided";
     };
  };
  name: "Facebook Messenger";
  operations: readonly [{
     alias: "messenger.webhook.parse";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "receive";
     description: "Validate and parse an inbound Messenger webhook request.";
     exposesSensitiveData: true;
     extension: true;
     label: "Parse Messenger webhook";
     providerObject: "messengerWebhook";
     providerOperation: "parseMessengerWebhook";
     requiresCredential: true;
   }, {
     alias: "messenger.message.send";
     audiences: readonly ["customer-facing"];
     capability: "send";
     description: "Send a Messenger Platform message through the configured Page.";
     exposesSensitiveData: true;
     extension: true;
     externallyVisible: true;
     label: "Send Messenger message";
     providerObject: "messengerMessage";
     providerOperation: "sendMessage";
     requiresApproval: true;
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "messenger.senderAction.send";
     audiences: readonly ["customer-facing"];
     capability: "send";
     description: "Send Messenger sender actions such as typing indicators or mark-seen.";
     extension: true;
     externallyVisible: true;
     label: "Send Messenger sender action";
     providerObject: "messengerConversation";
     providerOperation: "sendSenderAction";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "messenger.attachment.upload";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "media";
     description: "Upload reusable attachment payloads for Messenger sends.";
     exposesSensitiveData: true;
     extension: true;
     externallyVisible: true;
     label: "Upload Messenger attachment";
     providerObject: "messengerAttachment";
     providerOperation: "uploadAttachment";
     requiresApproval: true;
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "messenger.conversations.list";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "search-provider-object";
     description: "List Messenger Page conversations with SDK-user-supplied filters.";
     exposesSensitiveData: true;
     extension: true;
     label: "List Messenger conversations";
     providerObject: "messengerConversation";
     providerOperation: "listConversations";
     requiresCredential: true;
   }, {
     alias: "messenger.conversationMessages.list";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "read-provider-object";
     description: "Read messages for a Messenger conversation.";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Messenger conversation messages";
     providerObject: "messengerMessage";
     providerOperation: "getConversationMessages";
     requiresCredential: true;
   }, {
     alias: "messenger.page.read";
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Read configured Facebook Page metadata for readiness diagnostics.";
     extension: true;
     label: "Read Messenger Page";
     providerObject: "messengerPage";
     providerOperation: "getPage";
     requiresCredential: true;
   }, {
     alias: "messenger.webhook-signature";
     audiences: readonly ["internal-support"];
     capability: "social.webhook-signature";
     description: "Validate Meta X-Hub-Signature-256 for Messenger webhook delivery.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Messenger webhook signature";
     providerObject: "messengerSignedWebhook";
     providerOperation: "validateMessengerWebhookSignature";
     requiresCredential: true;
  }];
  packageName: "@cognidesk/integration-social-messenger";
  privacyNotes: readonly ["Messenger PSIDs, profile names, message text, attachments, conversation metadata, and webhook payloads can contain customer data.", "Meta Page access tokens, app secrets, and webhook verify tokens stay server-side and are represented in Studio only as readiness state."];
  provider: "messenger";
  trustLevel: "official";
}, MessengerSocialIntegrationOptions, {
  messenger.attachment.upload: (input) => Promise<MessengerApiResponse>;
  messenger.conversationMessages.list: (input) => Promise<MessengerConversationResponse>;
  messenger.conversations.list: (input) => Promise<MessengerConversationResponse>;
  messenger.message.send: (input) => Promise<MessengerApiResponse>;
  messenger.page.read: () => Promise<MessengerSocialProviderResponse>;
  messenger.senderAction.send: (input) => Promise<MessengerApiResponse>;
  messenger.webhook-signature: (input) => Promise<boolean>;
  messenger.webhook.parse: (input) => Promise<MessengerWebhookPayload>;
}>;

Parameters¶

Parameter	Type
`options`	`MessengerSocialIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]; category: string; channelAudiences: ("customer-facing" | "internal-support" | "mixed")[]; coverage: { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }; credentialRequirements: { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]; directions: ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]; id: string; limitations: string[]; maintainers: { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]; metadata?: Record\<string, unknown>; name: string; operations: { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]; packageName: string; privacyNotes: string[]; provider: string; trustLevel: "community" | "official" | "verified" | "experimental"; } & { capabilities: readonly [{ audiences: readonly ["customer-facing", "mixed"]; capability: "receive"; description: "Validates and parses Messenger Platform webhook payloads after the SDK user's Page is subscribed to the messages webhook."; exposesSensitiveData: true; label: "Receive Messenger webhooks"; providerObjects: readonly [{ kind: "messengerWebhook"; label: "Messenger Webhook"; }, { kind: "messengerMessage"; label: "Messenger Message"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing"]; capability: "send"; description: "Sends Messenger Platform messages inside Meta's 24-hour standard messaging window or with SDK-user-approved MESSAGE_TAG non-promotional policy where permitted."; exposesSensitiveData: true; label: "Send Messenger messages"; providerObjects: readonly [{ kind: "messengerMessage"; label: "Messenger Message"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "draft"; description: "Builds text, attachment, quick reply, sender action, and tag payloads for SDK-user approval workflows."; exposesSensitiveData: true; label: "Build Messenger payloads"; providerObjects: readonly [{ kind: "messengerDraft"; label: "Messenger Draft"; }]; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "thread"; description: "Reads Messenger conversation and message metadata through the configured Meta SDK-backed Graph adapter or provider client with SDK-user-governed access and retention."; exposesSensitiveData: true; label: "Use Messenger conversations"; providerObjects: readonly [{ kind: "messengerConversation"; label: "Messenger Conversation"; }, { kind: "messengerMessage"; label: "Messenger Message"; }, { kind: "messengerPage"; label: "Messenger Page"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "read-provider-object"; description: "Reads Messenger conversation messages and metadata through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; label: "Read Messenger conversations"; providerObjects: readonly [{ kind: "messengerConversation"; label: "Messenger Conversation"; }, { kind: "messengerMessage"; label: "Messenger Message"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "search-provider-object"; description: "Lists Messenger Page conversations through the configured Meta SDK-backed Graph adapter or provider client with SDK-user-supplied filters such as user ID, fields, limits, and cursors."; exposesSensitiveData: true; label: "List Messenger conversations"; providerObjects: readonly [{ kind: "messengerConversation"; label: "Messenger Conversation"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "media"; description: "Sends attachment payloads and exposes inbound attachment metadata under SDK-user media policy."; exposesSensitiveData: true; label: "Use Messenger attachments"; providerObjects: readonly [{ kind: "messengerAttachment"; label: "Messenger Attachment"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "social.webhook-signature"; description: "Validates X-Hub-Signature-256 webhook signatures with the SDK user's Meta app secret."; exposesSensitiveData: true; extension: true; label: "Validate Meta webhook signatures"; providerObjects: readonly [{ kind: "messengerSignedWebhook"; label: "Messenger Signed Webhook"; }]; requiresCredential: true; }]; category: "social"; channelAudiences: readonly ["customer-facing", "mixed"]; coverage: { evidence: readonly [{ label: "Messenger webhooks"; url: "https://developers.facebook.com/documentation/business-messaging/messenger-platform/webhooks"; }, { label: "Page subscribed apps"; url: "https://developers.facebook.com/docs/graph-api/reference/page/subscribed_apps/"; }, { label: "Messenger Send API"; url: "https://developers.facebook.com/docs/messenger-platform/send-messages/message-tags"; }, { label: "Messenger sender actions"; url: "https://developers.facebook.com/docs/messenger-platform/send-messages/sender-actions"; }, { label: "Messenger attachment upload"; url: "https://developers.facebook.com/docs/messenger-platform/reference/attachment-upload-api"; }, { label: "Messenger conversation routing"; url: "https://developers.facebook.com/documentation/business-messaging/messenger-platform/conversation-routing"; }, { label: "Meta Business SDK for NodeJS"; url: "https://github.com/facebook/facebook-nodejs-business-sdk"; }]; notes: readonly ["Coverage is typed for selected Messenger Platform support workflows: Page messages send, text payloads, sender actions, attachment payload/upload helpers, conversation/message reads, Page readiness, webhook challenge handling, and X-Hub-Signature-256 validation.", "Runtime provider operations use Meta's facebook-nodejs-business-sdk when credentials are configured; hosts may inject a Messenger/Meta provider client override.", "Meta's current Messenger routing surface is Conversation Routing; deprecated Handover Protocol thread-control helpers are not advertised as a current handoff capability by this package.", "This is not full Messenger Platform coverage; Messenger profile, persistent menu, personas, discovery and engagement tools, account linking, NLP, analytics, marketing messages, conversation routing configuration, and broader Page/Graph administration remain outside this adapter."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ description: "Optional SDK-user-owned provider client implementing MessengerSocialProviderClient for Messenger Platform and selected Meta Graph operations."; id: "messenger-provider-client"; label: "Messenger/Meta provider client override"; metadata: { defaultClientPolicy: "facebook-nodejs-business-sdk-when-configured"; importPolicy: "provider-client-override-supported"; interface: "MessengerSocialProviderClient"; }; required: false; }, { description: "Server-side Meta Page access token used by the Meta SDK-backed Graph adapter or an injected Messenger/Meta provider client."; id: "messenger-page-access-token"; label: "Messenger Page access token"; metadata: { scopeKind: "provider-permission-labels"; }; required: true; scopes: readonly ["pages_messaging", "pages_show_list", "pages_read_engagement", "pages_manage_metadata"]; }, { description: "Page ID that owns the Messenger inbox and conversation graph."; id: "messenger-page-id"; label: "Facebook Page ID"; required: true; }, { description: "Server-side app secret used to validate X-Hub-Signature-256 webhook deliveries."; id: "messenger-app-secret"; label: "Meta app secret"; required: true; }, { description: "SDK-user-owned token checked during Meta webhook endpoint verification."; id: "messenger-webhook-verify-token"; label: "Webhook verify token"; required: false; }, { description: "SDK-user-confirmed Page subscribed_apps configuration for Messenger messages webhooks."; id: "messenger-page-webhook-subscription"; label: "Messenger Page messages webhook subscription"; required: false; }]; directions: readonly ["receive-only", "send-only", "bidirectional"]; id: "social.messenger"; limitations: readonly ["Available operations depend on the SDK user's Meta app mode, Page connection, permissions, Page access token, webhook subscriptions, and messaging window rules.", "Meta no longer supports Handover Protocol as the normal Messenger routing model; SDK users should configure Conversation Routing outside this adapter, and the thread-control client methods are deprecated provider escape hatches only.", "Consent, outbound-contact policy, human escalation, attachment retention, redaction, and deletion behavior remain SDK-user configuration.", "This package provides Messenger payload/webhook helpers and does not choose default automation, promotional messaging, retry, HTTP transport, or rate-limit policy."]; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { apiCoverage: { checkedAt: "2026-06-25"; fullMetaGraphCoverage: false; fullProviderApi: false; generatedFromOfficialSpec: false; implementedOperationCount: 8; machineReadableSpecStatus: "No official public complete Messenger Platform/Graph OpenAPI spec was found in facebook/openapi during this audit."; operationCatalog: "docs/provider-coverage/messenger-platform-graph-selected-api-2026-06-18.operations.json"; selectedOperationCount: 8; }; channelCoverage: { attachments: "facebook-nodejs-business-sdk-call"; conversationRouting: "provider-supported-not-typed"; conversations: "facebook-nodejs-business-sdk-call"; customTransportFallback: "package-owned-rest-adapter"; handoverProtocolThreadControl: "provider-supported-deprecated-typed-thread-control"; messages: "facebook-nodejs-business-sdk-call"; pageReadiness: "facebook-nodejs-business-sdk-call"; senderActions: "facebook-nodejs-business-sdk-call"; webhooks: "typed-challenge-verify-parse"; }; docs: "https://developers.facebook.com/docs/messenger-platform"; implementation: { allowedOperations: readonly [{ alias: "messenger.webhook.parse"; checksum: "not-applicable-local-helper"; id: "parseMessengerWebhook"; source: "local-webhook-parser"; target: "package.webhooks.parseMessengerWebhook"; }, { alias: "messenger.message.send"; checksum: "not-applicable-rest-adapter"; id: "sendMessage"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.senderAction.send"; checksum: "not-applicable-rest-adapter"; id: "sendSenderAction"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.attachment.upload"; checksum: "not-applicable-rest-adapter"; id: "uploadAttachment"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.conversations.list"; checksum: "not-applicable-rest-adapter"; id: "listConversations"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.conversationMessages.list"; checksum: "not-applicable-rest-adapter"; id: "getConversationMessages"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.page.read"; checksum: "not-applicable-rest-adapter"; id: "getPage"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "messenger.webhook-signature"; checksum: "not-applicable-local-helper"; id: "validateMessengerWebhookSignature"; source: "local-signature-helper"; target: "package.webhooks.validateMessengerWebhookSignature"; }]; implementationStrategy: "provider-sdk-default-with-typed-domain-adapter"; providerSdk: { license: "Platform License"; package: "facebook-nodejs-business-sdk"; runtimeCall: "FacebookAdsApi.call"; runtimeEntry: "FacebookAdsApi"; version: "24.0.1"; }; sdkDecision: "Meta's maintained facebook-nodejs-business-sdk@24.0.1 is provider-owned and exposes FacebookAdsApi.call(method, path, params). This package maps its strict Messenger support slice onto that SDK call surface by default; the package-owned REST adapter is retained only for explicit custom transport options such as fetch, graphApiBaseUrl, graphApiVersion, signal, timeoutMs, or retry."; verifiedAt: "2026-06-25"; }; manifestOnlySafe: true; providerClient: { customTransportFallbackPolicy: "package-owned-rest-adapter-for-fetch-base-version-signal-timeout-retry"; defaultClientPolicy: "facebook-nodejs-business-sdk-when-configured"; importPolicy: "provider-client-override-supported"; interface: "MessengerSocialProviderClient"; package: "facebook-nodejs-business-sdk-or-host-provided"; }; }; name: "Facebook Messenger"; operations: readonly [{ alias: "messenger.webhook.parse"; audiences: readonly ["customer-facing", "mixed"]; capability: "receive"; description: "Validate and parse an inbound Messenger webhook request."; exposesSensitiveData: true; extension: true; label: "Parse Messenger webhook"; providerObject: "messengerWebhook"; providerOperation: "parseMessengerWebhook"; requiresCredential: true; }, { alias: "messenger.message.send"; audiences: readonly ["customer-facing"]; capability: "send"; description: "Send a Messenger Platform message through the configured Page."; exposesSensitiveData: true; extension: true; externallyVisible: true; label: "Send Messenger message"; providerObject: "messengerMessage"; providerOperation: "sendMessage"; requiresApproval: true; requiresCredential: true; sideEffect: true; }, { alias: "messenger.senderAction.send"; audiences: readonly ["customer-facing"]; capability: "send"; description: "Send Messenger sender actions such as typing indicators or mark-seen."; extension: true; externallyVisible: true; label: "Send Messenger sender action"; providerObject: "messengerConversation"; providerOperation: "sendSenderAction"; requiresCredential: true; sideEffect: true; }, { alias: "messenger.attachment.upload"; audiences: readonly ["customer-facing", "mixed"]; capability: "media"; description: "Upload reusable attachment payloads for Messenger sends."; exposesSensitiveData: true; extension: true; externallyVisible: true; label: "Upload Messenger attachment"; providerObject: "messengerAttachment"; providerOperation: "uploadAttachment"; requiresApproval: true; requiresCredential: true; sideEffect: true; }, { alias: "messenger.conversations.list"; audiences: readonly ["customer-facing", "mixed"]; capability: "search-provider-object"; description: "List Messenger Page conversations with SDK-user-supplied filters."; exposesSensitiveData: true; extension: true; label: "List Messenger conversations"; providerObject: "messengerConversation"; providerOperation: "listConversations"; requiresCredential: true; }, { alias: "messenger.conversationMessages.list"; audiences: readonly ["customer-facing", "mixed"]; capability: "read-provider-object"; description: "Read messages for a Messenger conversation."; exposesSensitiveData: true; extension: true; label: "Read Messenger conversation messages"; providerObject: "messengerMessage"; providerOperation: "getConversationMessages"; requiresCredential: true; }, { alias: "messenger.page.read"; audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Read configured Facebook Page metadata for readiness diagnostics."; extension: true; label: "Read Messenger Page"; providerObject: "messengerPage"; providerOperation: "getPage"; requiresCredential: true; }, { alias: "messenger.webhook-signature"; audiences: readonly ["internal-support"]; capability: "social.webhook-signature"; description: "Validate Meta X-Hub-Signature-256 for Messenger webhook delivery."; exposesSensitiveData: true; extension: true; label: "Validate Messenger webhook signature"; providerObject: "messengerSignedWebhook"; providerOperation: "validateMessengerWebhookSignature"; requiresCredential: true; }]; packageName: "@cognidesk/integration-social-messenger"; privacyNotes: readonly ["Messenger PSIDs, profile names, message text, attachments, conversation metadata, and webhook payloads can contain customer data.", "Meta Page access tokens, app secrets, and webhook verify tokens stay server-side and are represented in Studio only as readiness state."]; provider: "messenger"; trustLevel: "official"; }, MessengerSocialIntegrationOptions, { messenger.attachment.upload: (input) => Promise\<MessengerApiResponse>; messenger.conversationMessages.list: (input) => Promise\<MessengerConversationResponse>; messenger.conversations.list: (input) => Promise\<MessengerConversationResponse>; messenger.message.send: (input) => Promise\<MessengerApiResponse>; messenger.page.read: () => Promise\<MessengerSocialProviderResponse>; messenger.senderAction.send: (input) => Promise\<MessengerApiResponse>; messenger.webhook-signature: (input) => Promise\<boolean>; messenger.webhook.parse: (input) => Promise\<MessengerWebhookPayload>; }>

messengerSocialCredentialStatuses()¶

function messengerSocialCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`MessengerCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

normalizeMessengerWebhookEvents()¶

function normalizeMessengerWebhookEvents(payload): MessengerNormalizedEvent[];

Parameters¶

Parameter	Type
`payload`	`MessengerWebhookPayload`

Returns¶

MessengerNormalizedEvent[]

parseMessengerWebhook()¶

function parseMessengerWebhook(request, options?): Promise<MessengerWebhookPayload>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseMessengerWebhookOptions`

Returns¶

Promise\<MessengerWebhookPayload>

validateMessengerWebhookSignature()¶

function validateMessengerWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	{ `appSecret`: `string`; `rawBody`: `string`; `signature`: `string`; }
`input.appSecret`	`string`
`input.rawBody`	`string`
`input.signature`	`string`

Returns¶

boolean

verifyMessengerWebhookChallenge()¶

function verifyMessengerWebhookChallenge(input): string;

Parameters¶

Parameter	Type
`input`	`MessengerChallengeVerificationInput`

Returns¶

string

References¶