Skip to main content

Trigger a flow

Returns 200 if the flow is triggered successfully

Request Body REQUIRED
askribeKey Askribe Key REQUIRED

Obtain the API key required to connect with Askribe servers from the Settings section in your Askribe flow dashboard.

configId Config Id REQUIRED

This is the config Id of the the distribution you want to trigger. You can get this from the Distribution List panel of the flow you want to trigger

context object

Pass a list of Key-Value pairs to be substituted in the flow

webPushConfig object
key Key for Web PN config

Required if the flow will run in Web Push channel. Not required for workflows

auth Auth for Web PN config

Required if the flow will run in Web Push channel. Not required for workflows

androidPushConfig object
fcmId FCM Key for Android PN config

Required if the flow will run in Android Push channel. Not required for workflows

receiversEmailAddress Email address of the recipient

Required if the flow will run in Email channel. Not required for workflows

receiversPhoneNumber Phone number of the recipient

Required if the flow will run in WhatsApp, SMS or Voice channel. Not required for workflows

slackUserId Slack user id of the recipient

Required if the flow will run in Slack channel. Not required for workflows

language Language

Use this parameter to set the language of the flow

iOSPushConfig object
apnsId APNS Id for iOS PN config

Required if the flow will run in iOS Push channel. Not required for workflows

Responses
200

Successfully triggered

Schema OPTIONAL
object