API Documentation
Endpoint Examples
Phone Numbers
Campaigns
Webhooks
Get All Webhooks
Returns all webhooks associated with the authenticated user’s company
curl --request GET \
--url http://sandbox.mintlify.com/webhook/flow/company/outbound \
--header 'Authorization: Bearer <token>'{
"status": "ok",
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo": "<string>",
"retry_delay": 123,
"retry_delay_unit": "SECONDS",
"max_retries": 123,
"status": "SCHEDULED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"executions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "scheduled",
"attempt_number": 123,
"next_retry_at": "2023-11-07T05:31:56Z",
"executed_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_number": 123,
"webhook_url": "<string>",
"webhook_url_params": {},
"webhook_method": "GET",
"webhook_headers": {},
"webhook_body": {},
"webhook_timeout": 123,
"depends_on_step": 123,
"retry_limit": 123,
"timeout": 123,
"success_condition": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"is_template": true,
"flow_direction": "INBOUND",
"flow_mapping": {},
"predefinedVariables": [
{
"name": "<string>",
"value": "<string>"
}
],
"variables": [
{
"name": "<string>",
"location": "<string>",
"stepId": 123,
"type": "<string>",
"dataType": "<string>",
"customValue": "<string>"
}
],
"tag_name": "<string>",
"category_name": "<string>"
}
]
}Get Webhooks
Overview
This endpoint retrieves a list of Webhooks associated with the authenticated user’s company.
Endpoint Details
- URL:
https://api.callab.ai/webhook/flow/company/outbound - Method:
GET - Authentication: Required (
API KEY)
Request Headers
| Header | Value | Description |
|---|---|---|
Authorization | Bearer <api_key> | Your API KEY |
Response Format
The response will include a list of webhook flows with their details, including:
- Flow identification (ID, name, company)
- Configuration (retry settings, status)
- Execution history
- Flow steps and variables
- Metadata (tags, categories)
For the complete response schema, refer to the OpenAPI specification above.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
ok, error Name of the flow
Current status of the flow
SCHEDULED, IN_PROGRESS, RUNNING, FAILED, STOPPED, DELETED Unique identifier for the flow
ID of the user who created the flow
ID of the company that created the flow
Logo of the flow
Retry delay in specified units
Unit of retry delay
SECONDS, MINUTES, HOURS, DAYS Maximum number of retries
Timestamp when the flow was created
Timestamp when the flow was last updated
Timestamp when the flow was deleted
List of executions associated with the flow
Unique identifier for the execution
Current status of the execution
scheduled, in_progress, success, failed Number of attempts made for this execution
Timestamp for the next retry attempt
Timestamp when the execution was initiated
Timestamp when the execution was completed or failed
Error message if the execution failed
Timestamp when the execution record was created
Timestamp when the execution record was last updated
List of steps associated with the flow
Unique identifier for the step
Sequential number of the step in the flow
URL to which the webhook request will be sent
Parameters to be included in the webhook URL
HTTP method to use for the webhook request
GET, POST, PUT, DELETE Headers to be included in the webhook request
Body of the webhook request
Timeout duration (in seconds) for the webhook request
Step number on which this step depends
Maximum number of retries for this step
Timeout duration (in seconds) for the step
Conditions that determine if the step execution is successful
Timestamp when the step was created
Timestamp when the step was last updated
Timestamp when the step was deleted
Indicates if the flow is a template
Direction of the flow
INBOUND, OUTBOUND Flow mapping configuration
Tag associated with the flow
Category associated with the flow
Was this page helpful?
curl --request GET \
--url http://sandbox.mintlify.com/webhook/flow/company/outbound \
--header 'Authorization: Bearer <token>'{
"status": "ok",
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo": "<string>",
"retry_delay": 123,
"retry_delay_unit": "SECONDS",
"max_retries": 123,
"status": "SCHEDULED",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"executions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "scheduled",
"attempt_number": 123,
"next_retry_at": "2023-11-07T05:31:56Z",
"executed_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_number": 123,
"webhook_url": "<string>",
"webhook_url_params": {},
"webhook_method": "GET",
"webhook_headers": {},
"webhook_body": {},
"webhook_timeout": 123,
"depends_on_step": 123,
"retry_limit": 123,
"timeout": 123,
"success_condition": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"is_template": true,
"flow_direction": "INBOUND",
"flow_mapping": {},
"predefinedVariables": [
{
"name": "<string>",
"value": "<string>"
}
],
"variables": [
{
"name": "<string>",
"location": "<string>",
"stepId": 123,
"type": "<string>",
"dataType": "<string>",
"customValue": "<string>"
}
],
"tag_name": "<string>",
"category_name": "<string>"
}
]
}