Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface Webhook

    Represents a destination for receiving callbacks from the Conversation API.

    interface Webhook {
        app_id?: string;
        client_credentials?: ClientCredentials;
        id?: string;
        secret?: string;
        target: string;
        target_type?: string;
        triggers?: WebhookTrigger[];
    }
    Index

    Properties

    app_id? client_credentials? id? secret? target target_type? triggers?

    Properties

    app_id?: string

    The app that this webhook belongs to.

    client_credentials?: ClientCredentials

    ClientCredentials

    id?: string

    The ID of the webhook.

    secret?: string

    Optional secret be used to sign contents of webhooks sent by the Conversation API. You can then use the secret to verify the signature.

    target: string

    The target url where events should be sent to. Maximum URL length is 742. The conversation-api.*.sinch.com subdomains are forbidden.

    target_type?: string

    WebhookTargetType

    triggers?: WebhookTrigger[]

    An array of triggers that should trigger the webhook and result in an event being sent to the target url. Refer to the list of Webhook Triggers for a complete list.

    Settings

    Member Visibility

    On This Page

    Properties