Workflow Triggers

Create workflow trigger

Create a new trigger for a workflow. Triggers define when the workflow should automatically execute.

Trigger types:

inbound_message: Workflow starts when WhatsApp messages arrive at specified phone number (requires phone_number_id)
api_call: Workflow starts only via POST /workflows//executions (no phone_number_id needed)

After creating a trigger:

For inbound_message: Messages to the phone_number_id will start workflow executions
For api_call: Workflow can only be started via API endpoint

Note: A workflow can have multiple triggers (e.g., multiple phone numbers, or both inbound_message and api_call).

POST

workflows

{workflow_id}

triggers

Create workflow trigger

curl --request POST \
  --url https://api.kapso.ai/platform/v1/workflows/{workflow_id}/triggers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "trigger": {
    "active": true,
    "phone_number_id": "123456789012345"
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "active": true,
    "display_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "triggerable": {
      "phone_number_id": "<string>"
    }
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

workflow_id

string<uuid>

required

Workflow identifier

Body

application/json

Request to create a new workflow trigger

trigger

object

required

Show child attributes

Response

Trigger created successfully

Single workflow trigger response

data

object

required

Workflow trigger defining when and how a workflow execution should start

Show child attributes

Delete workflow triggerPermanently delete a workflow trigger. This will stop the workflow from executing automatically based on this trigger. After deletion: - For inbound_message triggers: Messages to the phone_number_id will no longer start this workflow - For api_call triggers: The workflow can still be started manually via POST /workflows/{id}/executions This operation cannot be undone. If you need to temporarily disable a trigger, use PATCH to set active=false instead.

Create workflow trigger

curl --request POST \
  --url https://api.kapso.ai/platform/v1/workflows/{workflow_id}/triggers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "trigger": {
    "active": true,
    "phone_number_id": "123456789012345"
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "active": true,
    "display_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "triggerable": {
      "phone_number_id": "<string>"
    }
  }
}