zendesk-messaging-client
    Preparing search index...

    Type Alias MessagebirdReadable

    MessagebirdReadable: IntegrationReadable & { type: "messagebird" } & {
        originator: string;
        type?: string;
        webhookSecret?: string;
    } & DefaultResponderReadable

    Type declaration

    • type: "messagebird"
    • originator: string

      Sunshine Conversations will receive all messages sent to this phone number.

    • Optionaltype?: string

      To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint. The response will include the integration’s _id and webhookSecret, which must be used to configure the webhook in MessageBird. In the Flow Builder for the MessageBird number you’ve used to integrate, add a new step with the following settings:

      • Create a new Call HTTP endpoint with SMS flow.
      • Select your desired SMS number for Incoming SMS.
      • Click on Forward to URL and set its method to POST.
      • Then, using the integration _id and webhookSecret returned from the create integration call, enter the following into the URL field: https://app.smooch.io/api/messagebird/webhooks/{appId}/{integrationId}/{webhookSecret}
      • Select application/json for the Set Content-Type header field.
      • Save and publish your changes.
    • Optional ReadonlywebhookSecret?: string

      The secret that is used to configure webhooks in MessageBird.