dist¶

Interfaces¶

InstagramAccountResource¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

followers_count?¶

optional followers_count?: number;

follows_count?¶

optional follows_count?: number;

id?¶

optional id?: string;

media_count?¶

optional media_count?: number;

name?¶

optional name?: string;

profile_picture_url?¶

optional profile_picture_url?: string;

username?¶

optional username?: string;

InstagramConversationResource¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

id?¶

optional id?: string;

link?¶

optional link?: string;

messages?¶

optional messages?: InstagramGraphCollection<InstagramSocialJsonObject>;

participants?¶

optional participants?: InstagramGraphCollection<InstagramSocialJsonObject>;

updated_time?¶

optional updated_time?: string;

InstagramCredentialStatusInput¶

Properties¶

appSecret?¶

optional appSecret?: string;

expiresAt?¶

optional expiresAt?: string;

instagramBusinessAccountId?¶

optional instagramBusinessAccountId?: string;

pageAccessToken?¶

optional pageAccessToken?: string;

pageId?¶

optional pageId?: string;

pageWebhookSubscribed?¶

optional pageWebhookSubscribed?: boolean;

permissions?¶

optional permissions?: string[];

verifyToken?¶

optional verifyToken?: string;

InstagramGraphCollection¶

Type Parameters¶

Type Parameter
`T`

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

data?¶

optional data?: T[];

paging?¶

optional paging?: InstagramPaging;

summary?¶

optional summary?: InstagramSocialJsonObject;

InstagramListConversationsInput¶

Properties¶

accountId?¶

optional accountId?: string;

after?¶

optional after?: string;

before?¶

optional before?: string;

fields?¶

optional fields?: string[];

limit?¶

optional limit?: number;

InstagramListMessagesInput¶

Properties¶

after?¶

optional after?: string;

before?¶

optional before?: string;

fields?¶

optional fields?: string[];

limit?¶

optional limit?: number;

InstagramLiveCheckOptions¶

Extends¶

InstagramSocialClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

InstagramSocialClientOptions.accessToken

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

InstagramSocialClientOptions.baseUrl

client?¶

optional client?: Pick<InstagramSocialClient, "getInstagramBusinessAccount" | "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¶

InstagramSocialClientOptions.fetch

graphApiBaseUrl?¶

optional graphApiBaseUrl?: string;

Inherited from¶

InstagramSocialClientOptions.graphApiBaseUrl

graphApiVersion?¶

optional graphApiVersion?: string;

Inherited from¶

InstagramSocialClientOptions.graphApiVersion

instagramBusinessAccountId?¶

optional instagramBusinessAccountId?: string;

Inherited from¶

InstagramSocialClientOptions.instagramBusinessAccountId

pageAccessToken?¶

optional pageAccessToken?: string;

Inherited from¶

InstagramSocialClientOptions.pageAccessToken

pageId?¶

optional pageId?: string;

Inherited from¶

InstagramSocialClientOptions.pageId

providerClient?¶

optional providerClient?: InstagramMetaProviderClient;

Inherited from¶

InstagramSocialClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from¶

InstagramSocialClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

InstagramSocialClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

InstagramSocialClientOptions.timeoutMs

InstagramMessageInput¶

Properties¶

additionalFields?¶

optional additionalFields?: InstagramSocialProviderExtensionFields;

message¶

message: InstagramSocialJsonObject;

messagingType?¶

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

recipient¶

recipient: InstagramMessageRecipient;

senderId?¶

optional senderId?: string;

tag?¶

optional tag?: string;

InstagramMessageRecipient¶

Properties¶

id¶

id: string;

InstagramMessageResource¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

attachments?¶

optional attachments?: InstagramGraphCollection<InstagramSocialJsonObject>;

created_time?¶

optional created_time?: string;

from?¶

optional from?: InstagramSocialJsonObject;

id?¶

optional id?: string;

message?¶

optional message?: string;

to?¶

optional to?: InstagramSocialJsonObject;

InstagramMessageResponse¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

message_id?¶

optional message_id?: string;

recipient_id?¶

optional recipient_id?: string;

InstagramPageResource¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

id?¶

optional id?: string;

instagram_business_account?¶

optional instagram_business_account?: InstagramAccountResource;

name?¶

optional name?: string;

InstagramPaging¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

cursors?¶

optional cursors?: {
  after?: string;
  before?: string;
};

after?¶

optional after?: string;

before?¶

optional before?: string;

next?¶

optional next?: string;

previous?¶

optional previous?: string;

InstagramSignedWebhook¶

Properties¶

contentType?¶

optional contentType?: string;

payload¶

payload: InstagramWebhookPayload;

rawBody¶

rawBody: string;

InstagramSocialClient¶

Properties¶

providerClient¶

providerClient: InstagramMetaProviderClient;

Methods¶

getInstagramBusinessAccount()¶

getInstagramBusinessAccount(fields?): Promise<InstagramAccountResource>;

Parameters¶

Parameter	Type
`fields?`	`string`[]

Returns¶

Promise\<InstagramAccountResource>

getMessage()¶

getMessage(messageId, fields?): Promise<InstagramMessageResource>;

Parameters¶

Parameter	Type
`messageId`	`string`
`fields?`	`string`[]

Returns¶

Promise\<InstagramMessageResource>

getPage()¶

getPage(fields?): Promise<InstagramPageResource>;

Parameters¶

Parameter	Type
`fields?`	`string`[]

Returns¶

Promise\<InstagramPageResource>

listConversationMessages()¶

listConversationMessages(conversationId, input?): Promise<InstagramGraphCollection<InstagramMessageResource>>;

Parameters¶

Parameter	Type
`conversationId`	`string`
`input?`	`InstagramListMessagesInput`

Returns¶

Promise\<InstagramGraphCollection\<InstagramMessageResource>>

listConversations()¶

listConversations(input?): Promise<InstagramGraphCollection<InstagramConversationResource>>;

Parameters¶

Parameter	Type
`input?`	`InstagramListConversationsInput`

Returns¶

Promise\<InstagramGraphCollection\<InstagramConversationResource>>

sendMessage()¶

sendMessage(input): Promise<InstagramMessageResponse>;

Parameters¶

Parameter	Type
`input`	`InstagramMessageInput`

Returns¶

Promise\<InstagramMessageResponse>

sendTextMessage()¶

sendTextMessage(input): Promise<InstagramMessageResponse>;

Parameters¶

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

Returns¶

Promise\<InstagramMessageResponse>

InstagramSocialClientOptions¶

Extended by¶

InstagramLiveCheckOptions

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;

instagramBusinessAccountId?¶

optional instagramBusinessAccountId?: string;

pageAccessToken?¶

optional pageAccessToken?: string;

pageId?¶

optional pageId?: string;

providerClient?¶

optional providerClient?: InstagramMetaProviderClient;

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

InstagramSocialJsonObject¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

InstagramSocialProviderExtensionFields¶

Extends¶

InstagramSocialJsonObject

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

InstagramSocialProviderResponse¶

Extends¶

InstagramSocialJsonObject

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

InstagramWebhookChange¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

field?¶

optional field?: string;

value?¶

optional value?: InstagramSocialJsonObject;

InstagramWebhookEntry¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

changes?¶

optional changes?: InstagramWebhookChange[];

id?¶

optional id?: string;

messaging?¶

optional messaging?: InstagramWebhookMessagingEvent[];

time?¶

optional time?: number;

InstagramWebhookMessagingEvent¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

delivery?¶

optional delivery?: InstagramSocialJsonObject;

message?¶

optional message?: {
[key: string]: InstagramSocialProviderExtensionValue;
  attachments?: InstagramSocialJsonValue[];
  mid?: string;
  quick_reply?: InstagramSocialJsonObject;
  reply_to?: InstagramSocialJsonObject;
  text?: string;
};

Index Signature¶

[key: string]: InstagramSocialProviderExtensionValue

attachments?¶

optional attachments?: InstagramSocialJsonValue[];

mid?¶

optional mid?: string;

quick_reply?¶

optional quick_reply?: InstagramSocialJsonObject;

reply_to?¶

optional reply_to?: InstagramSocialJsonObject;

text?¶

optional text?: string;

postback?¶

optional postback?: InstagramSocialJsonObject;

reaction?¶

optional reaction?: InstagramSocialJsonObject;

read?¶

optional read?: InstagramSocialJsonObject;

recipient?¶

optional recipient?: {
[key: string]: InstagramSocialJsonValue;
  id?: string;
};

Index Signature¶

[key: string]: InstagramSocialJsonValue

id?¶

optional id?: string;

sender?¶

optional sender?: {
[key: string]: InstagramSocialJsonValue;
  id?: string;
};

Index Signature¶

[key: string]: InstagramSocialJsonValue

id?¶

optional id?: string;

timestamp?¶

optional timestamp?: number;

InstagramWebhookPayload¶

Indexable¶

[key: string]: InstagramSocialProviderExtensionValue

Properties¶

entry?¶

optional entry?: InstagramWebhookEntry[];

object?¶

optional object?: string;

ParseInstagramWebhookOptions¶

Properties¶

appSecret?¶

optional appSecret?: string;

requireSignature?¶

optional requireSignature?: boolean;

ValidateInstagramWebhookSignatureInput¶

Properties¶

appSecret¶

appSecret: string;

rawBody¶

rawBody: string | Buffer<ArrayBufferLike>;

signature¶

signature: string;

VerifyInstagramWebhookChallengeInput¶

Properties¶

challenge¶

challenge: string;

expectedVerifyToken¶

expectedVerifyToken: string;

mode¶

mode: string;

verifyToken¶

verifyToken: string;

Type Aliases¶

InstagramMetaProviderClient¶

type InstagramMetaProviderClient = Omit<InstagramSocialClient, "providerClient" | "sendTextMessage">;

InstagramNormalizedEvent¶

type InstagramNormalizedEvent = {
  message: unknown;
  provider: "instagram";
  raw: unknown;
  type: "social.message.received";
};

Properties¶

message¶

message: unknown;

provider¶

provider: "instagram";

raw¶

raw: unknown;

type¶

type: "social.message.received";

InstagramSocialJsonPrimitive¶

type InstagramSocialJsonPrimitive = string | number | boolean | null;

InstagramSocialJsonValue¶

type InstagramSocialJsonValue =
  | InstagramSocialJsonPrimitive
  | InstagramSocialJsonObject
  | readonly InstagramSocialJsonValue[];

InstagramSocialProviderExtensionValue¶

type InstagramSocialProviderExtensionValue =
  | InstagramSocialJsonValue
  | object
  | undefined;

InstagramSocialProviderPayload¶

type InstagramSocialProviderPayload = InstagramSocialJsonObject | object;

InstagramSocialProviderQuery¶

type InstagramSocialProviderQuery = Record<string, InstagramSocialProviderExtensionValue>;

Functions¶

createInstagramSocialClient()¶

function createInstagramSocialClient(options?): InstagramSocialClient;

Parameters¶

Parameter	Type
`options?`	`InstagramSocialClientOptions`

Returns¶

InstagramSocialClient

createInstagramSocialLiveChecks()¶

function createInstagramSocialLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        accountId: string;
        pageId: string;
        pageName: string;
        username: string;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`InstagramLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { accountId: string; pageId: string; pageName: string; username: string; }; }>; }[]

createInstagramTextMessage()¶

function createInstagramTextMessage(input): InstagramMessageInput;

Parameters¶

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

Returns¶

InstagramMessageInput

defineInstagramSocialIntegration()¶

function defineInstagramSocialIntegration(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 Meta webhook payloads after the SDK user's Page/app is subscribed to Instagram messaging webhook fields.";
     exposesSensitiveData: true;
     label: "Receive Instagram DM webhooks";
     providerObjects: readonly [{
        kind: "instagramWebhook";
        label: "Instagram Webhook";
      }, {
        kind: "instagramDirectMessage";
        label: "Instagram Direct Message";
      }, {
        kind: "instagramConversation";
        label: "Instagram Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing"];
     capability: "send";
     description: "Sends Instagram direct messages through the configured Meta SDK-backed Graph adapter or provider client inside policy windows selected by the SDK user.";
     exposesSensitiveData: true;
     label: "Send Instagram DM messages";
     providerObjects: readonly [{
        kind: "instagramDirectMessage";
        label: "Instagram Direct Message";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "draft";
     description: "Builds Instagram messaging payloads for SDK-user-configured approval and routing workflows.";
     exposesSensitiveData: true;
     label: "Build Instagram DM payloads";
     providerObjects: readonly [{
        kind: "instagramMessageDraft";
        label: "Instagram Message Draft";
     }];
     requiresCredential: false;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "thread";
     description: "Associates provider conversation and message IDs with Cognidesk conversation policy selected by SDK users.";
     exposesSensitiveData: true;
     label: "Use Instagram conversations";
     providerObjects: readonly [{
        kind: "instagramConversation";
        label: "Instagram Conversation";
      }, {
        kind: "instagramDirectMessage";
        label: "Instagram Direct Message";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads Instagram professional account, page, conversation, and message resources through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     label: "Read Instagram account and messages";
     providerObjects: readonly [{
        kind: "instagramAccount";
        label: "Instagram Account";
      }, {
        kind: "instagramPage";
        label: "Facebook Page";
      }, {
        kind: "instagramConversation";
        label: "Instagram Conversation";
      }, {
        kind: "instagramDirectMessage";
        label: "Instagram Direct Message";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Lists Instagram conversations with SDK-user-supplied fields and pagination through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     label: "List Instagram conversations";
     providerObjects: readonly [{
        kind: "instagramConversation";
        label: "Instagram Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "social.webhook-signature";
     description: "Validates X-Hub-Signature-256 using the SDK user's Meta app secret before parsing webhook JSON.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Meta webhook signatures";
     providerObjects: readonly [{
        kind: "instagramSignedWebhook";
        label: "Instagram Signed Webhook";
     }];
     requiresCredential: true;
  }];
  category: "social";
  channelAudiences: readonly ["customer-facing", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Instagram Messaging overview";
        url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/overview";
      }, {
        label: "Instagram Messaging send message";
        url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/features/send-message";
      }, {
        label: "Instagram Messaging webhooks";
        url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/webhooks";
      }, {
        label: "Instagram Messaging app review";
        url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/app-review";
      }, {
        label: "Meta Business SDK for NodeJS";
        url: "https://github.com/facebook/facebook-nodejs-business-sdk";
     }];
     notes: readonly ["Coverage is limited to Instagram Messaging send payloads, conversations/messages reads, account/page reads, webhook challenge handling, and X-Hub-Signature-256 validation for SDK-user-owned support messaging.", "This package uses the Meta Business Messaging / Page access token model for Instagram Messaging; it does not implement the separate Instagram API with Instagram Login messaging surface.", "Runtime provider calls use Meta's facebook-nodejs-business-sdk when credentials are configured; hosts may inject an Instagram/Meta provider client override.", "The package does not implement the broader Instagram Platform for media publishing, comments/moderation, mentions, insights, content discovery, account management, or full Graph API coverage."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Server-side Page access token used by the Meta SDK-backed Graph adapter or an injected Instagram/Meta provider client.";
     id: "instagram-page-access-token";
     label: "Meta Page access token";
     metadata: {
        scopeKind: "provider-permission-labels";
     };
     required: true;
     scopes: readonly ["instagram_manage_messages", "instagram_basic", "pages_messaging", "pages_show_list", "pages_read_engagement", "pages_manage_metadata"];
   }, {
     description: "Facebook Page connected to the SDK user's Instagram professional account.";
     id: "instagram-page-id";
     label: "Facebook Page ID";
     required: true;
   }, {
     description: "Instagram professional account ID used for conversations, profile, and webhook ownership checks.";
     id: "instagram-business-account-id";
     label: "Instagram business account ID";
     required: true;
   }, {
     description: "Server-side app secret used to validate X-Hub-Signature-256 webhook deliveries.";
     id: "instagram-app-secret";
     label: "Meta app secret";
     required: true;
   }, {
     description: "SDK-user-owned token checked during Meta webhook endpoint verification.";
     id: "instagram-webhook-verify-token";
     label: "Webhook verify token";
     required: false;
   }, {
     description: "SDK-user-confirmed Page/app subscription to Instagram messaging webhook fields.";
     id: "instagram-page-webhook-subscription";
     label: "Instagram messaging webhook subscription";
     required: false;
   }, {
     description: "SDK-user-reviewed permissions granted to the Meta app and enforced by the configured Meta SDK-backed Graph adapter or provider client.";
     id: "instagram-permissions";
     label: "Instagram Graph permissions";
     metadata: {
        scopeKind: "provider-permission-labels";
     };
     required: true;
     scopes: readonly ["instagram_manage_messages", "instagram_basic", "pages_messaging", "pages_read_engagement", "pages_manage_metadata"];
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "social.instagram";
  limitations: readonly ["Available operations depend on the SDK user's Meta app review, Page ownership, Instagram professional account link, granted permissions, webhook field subscriptions, messaging windows, HUMAN_AGENT review, rate limits, and regional policy.", "Instagram does not inherit general Messenger message tags as safe defaults; SDK users must configure Instagram-specific outbound policy and HUMAN_AGENT review where needed.", "Consent, outbound-contact policy, conversation continuity across channels, human escalation, retention, redaction, and deletion behavior are SDK-user configuration.", "This package provides typed operation contracts, webhook primitives, and a Meta SDK-backed Graph adapter; providerClient injection remains available as an override."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     apiCoverage: {
        checkedAt: "2026-06-25";
        fullMetaGraphCoverage: false;
        fullProviderApi: false;
        generatedFromOfficialSpec: false;
        implementedOperationCount: 6;
        machineReadableSpecStatus: "No official public complete Instagram Messaging/Graph OpenAPI spec or dedicated typed Instagram Messaging SDK surface was found during this audit.";
        operationCatalog: "docs/provider-coverage/instagram-messaging-graph-selected-api-2026-06-18.operations.json";
        selectedOperationCount: 6;
     };
     channelCoverage: {
        accountPageReadiness: "facebook-nodejs-business-sdk-call";
        commentsPublishingInsights: "not-covered";
        conversations: "facebook-nodejs-business-sdk-call";
        customTransportFallback: "package-owned-rest-adapter";
        directMessages: "facebook-nodejs-business-sdk-call";
        humanAgentWindow: "sdk-owned-policy";
        messageDetails: "facebook-nodejs-business-sdk-call";
        webhooks: "typed-challenge-verify-parse";
     };
     docs: readonly ["https://developers.facebook.com/documentation/business-messaging/instagram-messaging/features/send-message", "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/overview", "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/webhooks"];
     implementation: {
        allowedOperations: readonly [{
           alias: "instagram.message.send";
           id: "sendMessage";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "instagram.conversations.list";
           id: "listConversations";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "instagram.conversationMessages.list";
           id: "listConversationMessages";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "instagram.message.read";
           id: "getMessage";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "instagram.account.read";
           id: "getInstagramBusinessAccount";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
         }, {
           alias: "instagram.page.read";
           id: "getPage";
           source: "provider-sdk";
           target: "facebookBusinessSdk.FacebookAdsApi.call";
        }];
        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 official facebook-nodejs-business-sdk@24.0.1 is provider-owned and exposes FacebookAdsApi.call(method, path, params). This package maps its strict Instagram Messaging 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";
     };
     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: "InstagramMetaProviderClient";
        package: "facebook-nodejs-business-sdk-or-host-provided";
     };
  };
  name: "Instagram Direct Messages";
  operations: readonly [{
     alias: "instagram.webhook.parse";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "receive";
     description: "Validate and parse an inbound Instagram Messaging webhook request.";
     exposesSensitiveData: true;
     extension: true;
     label: "Parse Instagram webhook";
     providerObject: "instagramWebhook";
     providerOperation: "parseInstagramWebhook";
     requiresCredential: true;
   }, {
     alias: "instagram.message.send";
     audiences: readonly ["customer-facing"];
     capability: "send";
     description: "Send an Instagram Messaging direct message through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     extension: true;
     externallyVisible: true;
     label: "Send Instagram message";
     providerObject: "instagramDirectMessage";
     providerOperation: "sendMessage";
     requiresApproval: true;
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "instagram.draft.create";
     audiences: readonly ["customer-facing", "mixed"];
     capability: "draft";
     description: "Build an Instagram Messaging payload for SDK-user approval workflows.";
     exposesSensitiveData: true;
     extension: true;
     label: "Build Instagram message payload";
     providerObject: "instagramMessageDraft";
     providerOperation: "createInstagramTextMessage";
   }, {
     alias: "instagram.conversations.list";
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "List Instagram conversations through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     extension: true;
     label: "List Instagram conversations";
     providerObject: "instagramConversation";
     providerOperation: "listConversations";
     requiresCredential: true;
   }, {
     alias: "instagram.conversationMessages.list";
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Read messages for an Instagram conversation through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Instagram conversation messages";
     providerObject: "instagramDirectMessage";
     providerOperation: "listConversationMessages";
     requiresCredential: true;
   }, {
     alias: "instagram.message.read";
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Read an Instagram message by provider message ID through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Instagram message";
     providerObject: "instagramDirectMessage";
     providerOperation: "getMessage";
     requiresCredential: true;
   }, {
     alias: "instagram.account.read";
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Read configured Instagram professional account metadata through the configured Meta SDK-backed Graph adapter or provider client.";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Instagram account";
     providerObject: "instagramAccount";
     providerOperation: "getInstagramBusinessAccount";
     requiresCredential: true;
   }, {
     alias: "instagram.page.read";
     audiences: readonly ["internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Read the Facebook Page connected to the Instagram professional account through the configured Meta SDK-backed Graph adapter or provider client.";
     extension: true;
     label: "Read connected Facebook Page";
     providerObject: "instagramPage";
     providerOperation: "getPage";
     requiresCredential: true;
   }, {
     alias: "instagram.webhook-signature";
     audiences: readonly ["internal-support"];
     capability: "social.webhook-signature";
     description: "Validate Meta X-Hub-Signature-256 for Instagram webhook delivery.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Instagram webhook signature";
     providerObject: "instagramSignedWebhook";
     providerOperation: "validateInstagramWebhookSignature";
     requiresCredential: true;
  }];
  packageName: "@cognidesk/integration-social-instagram";
  privacyNotes: readonly ["Instagram profile identifiers, usernames, message text, attachments, reactions, read events, conversation IDs, 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: "instagram";
  trustLevel: "official";
}, InstagramSocialIntegrationOptions, {
  instagram.account.read: (input) => Promise<InstagramAccountResource>;
  instagram.conversationMessages.list: (input) => Promise<InstagramGraphCollection<InstagramMessageResource>>;
  instagram.conversations.list: (input) => Promise<InstagramGraphCollection<InstagramConversationResource>>;
  instagram.draft.create: (input) => Promise<InstagramMessageInput>;
  instagram.message.read: (input) => Promise<InstagramMessageResource>;
  instagram.message.send: (input) => Promise<InstagramMessageResponse>;
  instagram.page.read: (input) => Promise<InstagramPageResource>;
  instagram.webhook-signature: (input) => Promise<boolean>;
  instagram.webhook.parse: (input) => Promise<InstagramSignedWebhook>;
}>;

Parameters¶

Parameter	Type
`options`	`InstagramSocialIntegrationOptions`

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 Meta webhook payloads after the SDK user's Page/app is subscribed to Instagram messaging webhook fields."; exposesSensitiveData: true; label: "Receive Instagram DM webhooks"; providerObjects: readonly [{ kind: "instagramWebhook"; label: "Instagram Webhook"; }, { kind: "instagramDirectMessage"; label: "Instagram Direct Message"; }, { kind: "instagramConversation"; label: "Instagram Conversation"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing"]; capability: "send"; description: "Sends Instagram direct messages through the configured Meta SDK-backed Graph adapter or provider client inside policy windows selected by the SDK user."; exposesSensitiveData: true; label: "Send Instagram DM messages"; providerObjects: readonly [{ kind: "instagramDirectMessage"; label: "Instagram Direct Message"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "draft"; description: "Builds Instagram messaging payloads for SDK-user-configured approval and routing workflows."; exposesSensitiveData: true; label: "Build Instagram DM payloads"; providerObjects: readonly [{ kind: "instagramMessageDraft"; label: "Instagram Message Draft"; }]; requiresCredential: false; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "thread"; description: "Associates provider conversation and message IDs with Cognidesk conversation policy selected by SDK users."; exposesSensitiveData: true; label: "Use Instagram conversations"; providerObjects: readonly [{ kind: "instagramConversation"; label: "Instagram Conversation"; }, { kind: "instagramDirectMessage"; label: "Instagram Direct Message"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Reads Instagram professional account, page, conversation, and message resources through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; label: "Read Instagram account and messages"; providerObjects: readonly [{ kind: "instagramAccount"; label: "Instagram Account"; }, { kind: "instagramPage"; label: "Facebook Page"; }, { kind: "instagramConversation"; label: "Instagram Conversation"; }, { kind: "instagramDirectMessage"; label: "Instagram Direct Message"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "search-provider-object"; description: "Lists Instagram conversations with SDK-user-supplied fields and pagination through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; label: "List Instagram conversations"; providerObjects: readonly [{ kind: "instagramConversation"; label: "Instagram Conversation"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support"]; capability: "social.webhook-signature"; description: "Validates X-Hub-Signature-256 using the SDK user's Meta app secret before parsing webhook JSON."; exposesSensitiveData: true; extension: true; label: "Validate Meta webhook signatures"; providerObjects: readonly [{ kind: "instagramSignedWebhook"; label: "Instagram Signed Webhook"; }]; requiresCredential: true; }]; category: "social"; channelAudiences: readonly ["customer-facing", "mixed"]; coverage: { evidence: readonly [{ label: "Instagram Messaging overview"; url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/overview"; }, { label: "Instagram Messaging send message"; url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/features/send-message"; }, { label: "Instagram Messaging webhooks"; url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/webhooks"; }, { label: "Instagram Messaging app review"; url: "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/app-review"; }, { label: "Meta Business SDK for NodeJS"; url: "https://github.com/facebook/facebook-nodejs-business-sdk"; }]; notes: readonly ["Coverage is limited to Instagram Messaging send payloads, conversations/messages reads, account/page reads, webhook challenge handling, and X-Hub-Signature-256 validation for SDK-user-owned support messaging.", "This package uses the Meta Business Messaging / Page access token model for Instagram Messaging; it does not implement the separate Instagram API with Instagram Login messaging surface.", "Runtime provider calls use Meta's facebook-nodejs-business-sdk when credentials are configured; hosts may inject an Instagram/Meta provider client override.", "The package does not implement the broader Instagram Platform for media publishing, comments/moderation, mentions, insights, content discovery, account management, or full Graph API coverage."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ description: "Server-side Page access token used by the Meta SDK-backed Graph adapter or an injected Instagram/Meta provider client."; id: "instagram-page-access-token"; label: "Meta Page access token"; metadata: { scopeKind: "provider-permission-labels"; }; required: true; scopes: readonly ["instagram_manage_messages", "instagram_basic", "pages_messaging", "pages_show_list", "pages_read_engagement", "pages_manage_metadata"]; }, { description: "Facebook Page connected to the SDK user's Instagram professional account."; id: "instagram-page-id"; label: "Facebook Page ID"; required: true; }, { description: "Instagram professional account ID used for conversations, profile, and webhook ownership checks."; id: "instagram-business-account-id"; label: "Instagram business account ID"; required: true; }, { description: "Server-side app secret used to validate X-Hub-Signature-256 webhook deliveries."; id: "instagram-app-secret"; label: "Meta app secret"; required: true; }, { description: "SDK-user-owned token checked during Meta webhook endpoint verification."; id: "instagram-webhook-verify-token"; label: "Webhook verify token"; required: false; }, { description: "SDK-user-confirmed Page/app subscription to Instagram messaging webhook fields."; id: "instagram-page-webhook-subscription"; label: "Instagram messaging webhook subscription"; required: false; }, { description: "SDK-user-reviewed permissions granted to the Meta app and enforced by the configured Meta SDK-backed Graph adapter or provider client."; id: "instagram-permissions"; label: "Instagram Graph permissions"; metadata: { scopeKind: "provider-permission-labels"; }; required: true; scopes: readonly ["instagram_manage_messages", "instagram_basic", "pages_messaging", "pages_read_engagement", "pages_manage_metadata"]; }]; directions: readonly ["receive-only", "send-only", "bidirectional"]; id: "social.instagram"; limitations: readonly ["Available operations depend on the SDK user's Meta app review, Page ownership, Instagram professional account link, granted permissions, webhook field subscriptions, messaging windows, HUMAN_AGENT review, rate limits, and regional policy.", "Instagram does not inherit general Messenger message tags as safe defaults; SDK users must configure Instagram-specific outbound policy and HUMAN_AGENT review where needed.", "Consent, outbound-contact policy, conversation continuity across channels, human escalation, retention, redaction, and deletion behavior are SDK-user configuration.", "This package provides typed operation contracts, webhook primitives, and a Meta SDK-backed Graph adapter; providerClient injection remains available as an override."]; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { apiCoverage: { checkedAt: "2026-06-25"; fullMetaGraphCoverage: false; fullProviderApi: false; generatedFromOfficialSpec: false; implementedOperationCount: 6; machineReadableSpecStatus: "No official public complete Instagram Messaging/Graph OpenAPI spec or dedicated typed Instagram Messaging SDK surface was found during this audit."; operationCatalog: "docs/provider-coverage/instagram-messaging-graph-selected-api-2026-06-18.operations.json"; selectedOperationCount: 6; }; channelCoverage: { accountPageReadiness: "facebook-nodejs-business-sdk-call"; commentsPublishingInsights: "not-covered"; conversations: "facebook-nodejs-business-sdk-call"; customTransportFallback: "package-owned-rest-adapter"; directMessages: "facebook-nodejs-business-sdk-call"; humanAgentWindow: "sdk-owned-policy"; messageDetails: "facebook-nodejs-business-sdk-call"; webhooks: "typed-challenge-verify-parse"; }; docs: readonly ["https://developers.facebook.com/documentation/business-messaging/instagram-messaging/features/send-message", "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/overview", "https://developers.facebook.com/documentation/business-messaging/instagram-messaging/webhooks"]; implementation: { allowedOperations: readonly [{ alias: "instagram.message.send"; id: "sendMessage"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "instagram.conversations.list"; id: "listConversations"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "instagram.conversationMessages.list"; id: "listConversationMessages"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "instagram.message.read"; id: "getMessage"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "instagram.account.read"; id: "getInstagramBusinessAccount"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }, { alias: "instagram.page.read"; id: "getPage"; source: "provider-sdk"; target: "facebookBusinessSdk.FacebookAdsApi.call"; }]; 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 official facebook-nodejs-business-sdk@24.0.1 is provider-owned and exposes FacebookAdsApi.call(method, path, params). This package maps its strict Instagram Messaging 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"; }; 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: "InstagramMetaProviderClient"; package: "facebook-nodejs-business-sdk-or-host-provided"; }; }; name: "Instagram Direct Messages"; operations: readonly [{ alias: "instagram.webhook.parse"; audiences: readonly ["customer-facing", "mixed"]; capability: "receive"; description: "Validate and parse an inbound Instagram Messaging webhook request."; exposesSensitiveData: true; extension: true; label: "Parse Instagram webhook"; providerObject: "instagramWebhook"; providerOperation: "parseInstagramWebhook"; requiresCredential: true; }, { alias: "instagram.message.send"; audiences: readonly ["customer-facing"]; capability: "send"; description: "Send an Instagram Messaging direct message through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; extension: true; externallyVisible: true; label: "Send Instagram message"; providerObject: "instagramDirectMessage"; providerOperation: "sendMessage"; requiresApproval: true; requiresCredential: true; sideEffect: true; }, { alias: "instagram.draft.create"; audiences: readonly ["customer-facing", "mixed"]; capability: "draft"; description: "Build an Instagram Messaging payload for SDK-user approval workflows."; exposesSensitiveData: true; extension: true; label: "Build Instagram message payload"; providerObject: "instagramMessageDraft"; providerOperation: "createInstagramTextMessage"; }, { alias: "instagram.conversations.list"; audiences: readonly ["internal-support", "mixed"]; capability: "search-provider-object"; description: "List Instagram conversations through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; extension: true; label: "List Instagram conversations"; providerObject: "instagramConversation"; providerOperation: "listConversations"; requiresCredential: true; }, { alias: "instagram.conversationMessages.list"; audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Read messages for an Instagram conversation through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; extension: true; label: "Read Instagram conversation messages"; providerObject: "instagramDirectMessage"; providerOperation: "listConversationMessages"; requiresCredential: true; }, { alias: "instagram.message.read"; audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Read an Instagram message by provider message ID through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; extension: true; label: "Read Instagram message"; providerObject: "instagramDirectMessage"; providerOperation: "getMessage"; requiresCredential: true; }, { alias: "instagram.account.read"; audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Read configured Instagram professional account metadata through the configured Meta SDK-backed Graph adapter or provider client."; exposesSensitiveData: true; extension: true; label: "Read Instagram account"; providerObject: "instagramAccount"; providerOperation: "getInstagramBusinessAccount"; requiresCredential: true; }, { alias: "instagram.page.read"; audiences: readonly ["internal-support", "mixed"]; capability: "read-provider-object"; description: "Read the Facebook Page connected to the Instagram professional account through the configured Meta SDK-backed Graph adapter or provider client."; extension: true; label: "Read connected Facebook Page"; providerObject: "instagramPage"; providerOperation: "getPage"; requiresCredential: true; }, { alias: "instagram.webhook-signature"; audiences: readonly ["internal-support"]; capability: "social.webhook-signature"; description: "Validate Meta X-Hub-Signature-256 for Instagram webhook delivery."; exposesSensitiveData: true; extension: true; label: "Validate Instagram webhook signature"; providerObject: "instagramSignedWebhook"; providerOperation: "validateInstagramWebhookSignature"; requiresCredential: true; }]; packageName: "@cognidesk/integration-social-instagram"; privacyNotes: readonly ["Instagram profile identifiers, usernames, message text, attachments, reactions, read events, conversation IDs, 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: "instagram"; trustLevel: "official"; }, InstagramSocialIntegrationOptions, { instagram.account.read: (input) => Promise\<InstagramAccountResource>; instagram.conversationMessages.list: (input) => Promise\<InstagramGraphCollection\<InstagramMessageResource>>; instagram.conversations.list: (input) => Promise\<InstagramGraphCollection\<InstagramConversationResource>>; instagram.draft.create: (input) => Promise\<InstagramMessageInput>; instagram.message.read: (input) => Promise\<InstagramMessageResource>; instagram.message.send: (input) => Promise\<InstagramMessageResponse>; instagram.page.read: (input) => Promise\<InstagramPageResource>; instagram.webhook-signature: (input) => Promise\<boolean>; instagram.webhook.parse: (input) => Promise\<InstagramSignedWebhook>; }>

instagramSocialCredentialStatuses()¶

function instagramSocialCredentialStatuses(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`	`InstagramCredentialStatusInput`

Returns¶

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

normalizeInstagramWebhookEvents()¶

function normalizeInstagramWebhookEvents(payload): InstagramNormalizedEvent[];

Parameters¶

Parameter	Type
`payload`	`InstagramWebhookPayload`

Returns¶

InstagramNormalizedEvent[]

parseInstagramWebhook()¶

function parseInstagramWebhook(request, options?): Promise<InstagramSignedWebhook>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseInstagramWebhookOptions`

Returns¶

Promise\<InstagramSignedWebhook>

validateInstagramWebhookSignature()¶

function validateInstagramWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	`ValidateInstagramWebhookSignatureInput`

Returns¶

boolean

verifyInstagramWebhookChallenge()¶

function verifyInstagramWebhookChallenge(input): string;

Parameters¶

Parameter	Type
`input`	`VerifyInstagramWebhookChallengeInput`

Returns¶

string

References¶