🔁 Pipelines

Retrieve and interact with message processing pipelines.

🔽 `GET /api/public/pipeline` – Get Pipelines

Use this endpoint to retrieve the list of available pipelines linked to your account. Pipelines define the flows or automations used in conversations, onboarding, campaigns, and more.

Click to expand full details

🔹 URL

GET /api/public/pipeline

🔹 Headers

Name	Type	Required	Description
`x-api-key`	string	✅	Your API key to authorize the request

🔹 Example Request (cURL)

curl --request GET \
  'https://iris-backend-production.up.railway.app/api/public/pipeline' \
  --header 'x-api-key: YOUR_API_KEY'

Replace YOUR_API_KEY with your actual API key.

🔹 Response Example

[
  {
    "id": "pipeline_welcome",
    "name": "Welcome Flow",
    "description": "Pipeline triggered after first QR scan",
    "status": "active"
  },
  {
    "id": "pipeline_survey",
    "name": "Survey Campaign",
    "description": "Post-purchase customer survey",
    "status": "active"
  }
]

🔹 Possible Responses

Code	Meaning	Description
200	OK	Successfully retrieved pipeline list
400	Bad Request	Request was malformed or incomplete
401	Unauthorized	API key was missing or incorrect

Updated 9 days ago