intercom-client/dist/api/types/SubmitResponse.d.ts

Official Node bindings to the Intercom API

/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Intercom from "../index";
/**
 * The response object returned when submitting an app interaction. This will replace the previous canvas that was visible until the app was interacted with.
 *
 * You can optionally provide an event object with the attribute `type` given as `completed` to tell us if the app has completed its purpose. For example, an email collector app would be complete when the end-user submits their email address.
 *
 * Apps in conversation details can also optionally insert an app into the conversation reply:
 *
 * 1. You respond with a card_creation_options object (https://developers.intercom.com/canvas-kit-reference/reference/card-creation-options)
 * 2. We send a request to the initialize URL for Messenger capabilities (https://developers.intercom.com/docs/build-an-integration/getting-started/build-an-app-for-your-messenger/request-flows) with the card_creation_options object present
 * 3. You respond with a canvas object with the components you want to insert into the conversation reply
 */
export interface SubmitResponse {
    /** The canvas object that defines the new UI to be shown. */
    canvas: Intercom.CanvasObject;
    /** Optional. Key-value pairs that will be sent in the initialize request to insert an app into the conversation reply. */
    card_creation_options?: Record<string, unknown>;
    /** Optional. Indicates if the app has completed its purpose. */
    event?: Intercom.Event;
}