Get All Webhooks

Get webhooks (outbound by default)

curl --request GET \
  --url https://api.callab.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "status": "ok",
  "message": "<string>",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_by": "123e4567-e89b-12d3-a456-426614174001",
      "company_id": "123e4567-e89b-12d3-a456-426614174001",
      "workspace_id": "default",
      "name": "VTIGER BRING CONTACTS",
      "logo": "<string>",
      "retry_delay": 5,
      "retry_delay_unit": "seconds",
      "max_retries": 3,
      "status": "scheduled",
      "created_at": "2023-10-01T12:34:56Z",
      "updated_at": "2023-10-02T12:34:56Z",
      "executions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "scheduled",
          "attempt_number": 123,
          "executed_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "next_retry_at": "2023-11-07T05:31:56Z",
          "finished_at": "2023-11-07T05:31:56Z",
          "error_message": "<string>"
        }
      ],
      "steps": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "step_number": 123,
          "webhook_url": "<string>",
          "webhook_method": "GET",
          "webhook_timeout": 123,
          "retry_limit": 3,
          "timeout": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "webhook_url_params": {},
          "webhook_headers": {},
          "webhook_body": {},
          "depends_on_step": 123,
          "success_condition": {},
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "is_template": false,
      "flow_direction": "inbound",
      "flow_mapping": {},
      "tag_name": "lead1",
      "category_name": "all leads",
      "deleted_at": "2023-10-03T12:34:56Z",
      "predefinedVariables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "variables": [
        {
          "name": "<string>",
          "location": "<string>",
          "stepId": 123,
          "type": "<string>",
          "dataType": "<string>",
          "customValue": "<string>"
        }
      ]
    }
  ]
}

GET

webhooks

Get webhooks (outbound by default)

curl --request GET \
  --url https://api.callab.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "status": "ok",
  "message": "<string>",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_by": "123e4567-e89b-12d3-a456-426614174001",
      "company_id": "123e4567-e89b-12d3-a456-426614174001",
      "workspace_id": "default",
      "name": "VTIGER BRING CONTACTS",
      "logo": "<string>",
      "retry_delay": 5,
      "retry_delay_unit": "seconds",
      "max_retries": 3,
      "status": "scheduled",
      "created_at": "2023-10-01T12:34:56Z",
      "updated_at": "2023-10-02T12:34:56Z",
      "executions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "scheduled",
          "attempt_number": 123,
          "executed_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "next_retry_at": "2023-11-07T05:31:56Z",
          "finished_at": "2023-11-07T05:31:56Z",
          "error_message": "<string>"
        }
      ],
      "steps": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "step_number": 123,
          "webhook_url": "<string>",
          "webhook_method": "GET",
          "webhook_timeout": 123,
          "retry_limit": 3,
          "timeout": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "webhook_url_params": {},
          "webhook_headers": {},
          "webhook_body": {},
          "depends_on_step": 123,
          "success_condition": {},
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "is_template": false,
      "flow_direction": "inbound",
      "flow_mapping": {},
      "tag_name": "lead1",
      "category_name": "all leads",
      "deleted_at": "2023-10-03T12:34:56Z",
      "predefinedVariables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "variables": [
        {
          "name": "<string>",
          "location": "<string>",
          "stepId": 123,
          "type": "<string>",
          "dataType": "<string>",
          "customValue": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspaceId

string

Optional Workspace ID to filter webhooks. Defaults to 'default' if not specified.

Response

200 - application/json

Webhooks response.

status

enum<string>

Available options:

ok,

error

message

string

data

object[]

A list of flow objects representing webhooks.

Show child attributes

data.id

string<uuid>

required

Unique identifier for the flow

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.created_by

string<uuid>

required

ID of the user who created the flow

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.company_id

string<uuid>

required

ID of the company who created the flow

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.workspace_id

string

default:default

required

ID of the workspace the flow belongs to. Defaults to "default" if not specified.

Example:

"default"

data.name

string

required

Name of the flow

Example:

"VTIGER BRING CONTACTS"

data.logo

string

required

Logo of the the flow

data.retry_delay

integer

required

Retry delay in specified units

Example:

5

data.retry_delay_unit

enum<string>

required

Unit of retry delay

Available options:

seconds,

minutes,

hours,

days

data.max_retries

integer

default:3

required

Maximum number of retries

Example:

3

data.status

enum<string>

default:scheduled

required

Current status of the flow

Available options:

scheduled,

in-progress,

running,

failed,

stopped,

deleted

data.created_at

string<date-time>

required

Timestamp when the flow was created

Example:

"2023-10-01T12:34:56Z"

data.updated_at

string<date-time>

required

Timestamp when the flow was last updated

Example:

"2023-10-02T12:34:56Z"

data.executions

object[]

required

List of executions associated with the flow

Show child attributes

data.executions.id

string<uuid>

required

Unique identifier for the execution

data.executions.status

enum<string>

required

Current status of the execution

Available options:

scheduled,

in_progress,

success,

failed

data.executions.attempt_number

integer

required

Number of attempts made for this execution

data.executions.executed_at

string<date-time>

required

Timestamp when the execution was initiated (equivalent to created_at in this context if it signifies start)

data.executions.created_at

string<date-time>

required

Timestamp when the execution record was created

data.executions.updated_at

string<date-time>

required

Timestamp when the execution record was last updated

data.executions.next_retry_at

string<date-time> | null

Timestamp for the next retry attempt

data.executions.finished_at

string<date-time> | null

Timestamp when the execution was completed or failed

data.executions.error_message

string | null

Error message if the execution failed

data.steps

object[]

required

List of steps associated with the flow

Show child attributes

data.steps.id

string<uuid>

required

Unique identifier for the step

data.steps.step_number

integer

required

Sequential number of the step in the flow

data.steps.webhook_url

string<uri>

required

URL to which the webhook request will be sent

data.steps.webhook_method

enum<string>

required

HTTP method to use for the webhook request

Available options:

GET,

POST,

PUT,

DELETE,

PATCH,

OPTIONS,

HEAD

data.steps.webhook_timeout

integer

required

Timeout duration (in seconds) for the webhook request

data.steps.retry_limit

integer

default:3

required

Maximum number of retries for this step

data.steps.timeout

integer

required

Timeout duration (in seconds) for the step execution itself

data.steps.created_at

string<date-time>

required

Timestamp when the step was created

data.steps.updated_at

string<date-time>

required

Timestamp when the step was last updated

data.steps.webhook_url_params

object

Parameters to be included in the webhook URL (key-value pairs)

data.steps.webhook_headers

object

Headers to be included in the webhook request (key-value pairs)

data.steps.webhook_body

object

Body of the webhook request (any JSON structure)

data.steps.depends_on_step

integer | null

Step number on which this step depends

data.steps.success_condition

object

Conditions that determine if the step execution is successful (any JSON structure)

data.steps.deleted_at

string<date-time> | null

Timestamp when the step was deleted

data.is_template

boolean

default:false

required

Indicates if the flow is a template

Example:

false

data.flow_direction

enum<string>

default:inbound

required

Direction of the flow

Available options:

inbound,

outbound

data.flow_mapping

object

required

Flow mapping configuration (any JSON object structure)

data.tag_name

string

required

Tag of the flow

Example:

"lead1"

data.category_name

string

required

Category of the flow

Example:

"all leads"

data.deleted_at

string<date-time> | null

Timestamp when the flow was deleted

Example:

"2023-10-03T12:34:56Z"

data.predefinedVariables

object[] | null

Predefined variables for the flow

Show child attributes

data.predefinedVariables.name

string

required

data.predefinedVariables.value

string

required

data.variables

object[] | null

Variables used in flow steps

Show child attributes

data.variables.name

string

required

data.variables.location

string

required

data.variables.stepId

integer

required

data.variables.type

string

required

data.variables.dataType

string | null

data.variables.customValue

string | null

delete a workspace Get All Integrations

⌘I

API Documentation

Calls API

Phone Numbers

Company Users

Contacts

Campaigns

AI Agents

Workspaces

Webhooks

integrations

Modules

Authorizations

Query Parameters

Response