SendPulse Chatbots icon

SendPulse Chatbots

Interact with SendPulse API

Actions5

Flow → Run

AI-generated

Summary

Trigger execution of a specified chatbot flow for a given contact on a chosen messaging channel.

Inputs

  • Authentication — Select authentication mechanism: either OAuth2 (Client ID & Client Secret) or Access Token.
  • Channel (required) — Select the chatbot channel where the flow will be run (e.g., Facebook Messenger, Instagram, Telegram, WhatsApp, etc.).
  • Contact ID (required) — Enter the ID of the contact for whom the flow will be executed.
  • Flow ID (required) — Enter the ID of the chatbot flow to run.
  • Additional Fields — Optionally specify additional data as key-value pairs to pass as external variables to the flow.
  • Request Options — Optional advanced HTTP request settings such as batching, proxy, timeout, and SSL handling.

Output shape

a single record (JSON object) containing the API response to running the flow

The operation sends a POST request to the SendPulse API endpoint corresponding to the selected channel. The request body includes contact_id, flow_id, and optionally external_data. The response returns the status and details of flow execution. No pagination applies.

Examples

Example 1: Run a Facebook Messenger flow

Use OAuth2 authentication, select 'messenger' channel, provide the target contact ID and the specific Flow ID. Optionally add external variables for the flow execution.

Links

Discussion