Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Orchestration

List orchestration webhooks

get
Authorizations
AuthorizationstringRequired
Path parameters
workspace_idstring · uuidRequired
Query parameters
descriptionanyOptional
is_activebooleanOptional
jobanyOptional

Filter by job id

methodanyOptional
orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

urlanyOptional
Responses
200Success
application/json
countintegerOptionalExample: 50
next_pageinteger · nullableOptionalExample: 3
previous_pageinteger · nullableOptionalExample: 1
page_sizeintegerOptionalExample: 10
total_pagesintegerOptionalExample: 5
current_pageintegerOptionalExample: 2
get/developers/workspaces/{workspace_id}/orchestration/webhooks/
GET /developers/workspaces/{workspace_id}/orchestration/webhooks/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 50,
  "next_page": 3,
  "previous_page": 1,
  "page_size": 10,
  "total_pages": 5,
  "current_page": 2,
  "results": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_created_at": "2026-01-01T00:00:00.000Z",
      "_updated_at": "2026-01-01T00:00:00.000Z",
      "description": "text",
      "is_active": true
    }
  ]
}

Create orchestration webhook

post
Authorizations
AuthorizationstringRequired
Path parameters
workspace_idstring · uuidRequired
Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
descriptionstring · max: 255Required
is_activebooleanRequired
methodstring · enumRequired
  • DELETE - DELETE
  • GET - GET
  • PATCH - PATCH
  • POST - POST
  • PUT - PUT
Possible values:
urlstring · max: 1000Required

An http:// or https:// URL. It may contain ${{variables.NAME}}, ${{secrets.NAME}} and ${{erathos.name}} references anywhere, the host included.

headerany · nullableOptional
bodyany · nullableOptional
jobsstring · uuid[]Optional

Jobs the webhook fires for. A webhook needs at least one job or connection. Left out of an update, the current jobs are kept.

connectionsstring · uuid[]Optional

Source connections the webhook fires for, covering every job of each, including jobs added later. Left out of an update, the current connections are kept.

Responses
201Success
application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
descriptionstring · max: 255Required
is_activebooleanRequired
methodstring · enumRequired
  • DELETE - DELETE
  • GET - GET
  • PATCH - PATCH
  • POST - POST
  • PUT - PUT
Possible values:
urlstring · max: 1000Required

An http:// or https:// URL. It may contain ${{variables.NAME}}, ${{secrets.NAME}} and ${{erathos.name}} references anywhere, the host included.

headerany · nullableOptional
bodyany · nullableOptional
jobsstring · uuid[]Optional

Jobs the webhook fires for. A webhook needs at least one job or connection. Left out of an update, the current jobs are kept.

connectionsstring · uuid[]Optional

Source connections the webhook fires for, covering every job of each, including jobs added later. Left out of an update, the current connections are kept.

post/developers/workspaces/{workspace_id}/orchestration/webhooks/
POST /developers/workspaces/{workspace_id}/orchestration/webhooks/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "text",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "connections": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
201Success
{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "text",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "connections": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Retrieve orchestration webhook

get
Authorizations
AuthorizationstringRequired
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Responses
200Success
application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
descriptionstring · max: 255Required
is_activebooleanRequired
methodstring · enumRequired
  • DELETE - DELETE
  • GET - GET
  • PATCH - PATCH
  • POST - POST
  • PUT - PUT
Possible values:
urlstring · max: 1000Required

An http:// or https:// URL. It may contain ${{variables.NAME}}, ${{secrets.NAME}} and ${{erathos.name}} references anywhere, the host included.

headerany · nullableOptional
bodyany · nullableOptional
jobsstring · uuid[]Optional

Jobs the webhook fires for. A webhook needs at least one job or connection. Left out of an update, the current jobs are kept.

connectionsstring · uuid[]Optional

Source connections the webhook fires for, covering every job of each, including jobs added later. Left out of an update, the current connections are kept.

get/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/
GET /developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "text",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "connections": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Edit orchestration webhook

put
Authorizations
AuthorizationstringRequired
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
descriptionstring · max: 255Required
is_activebooleanRequired
methodstring · enumRequired
  • DELETE - DELETE
  • GET - GET
  • PATCH - PATCH
  • POST - POST
  • PUT - PUT
Possible values:
urlstring · max: 1000Required

An http:// or https:// URL. It may contain ${{variables.NAME}}, ${{secrets.NAME}} and ${{erathos.name}} references anywhere, the host included.

headerany · nullableOptional
bodyany · nullableOptional
jobsstring · uuid[]Optional

Jobs the webhook fires for. A webhook needs at least one job or connection. Left out of an update, the current jobs are kept.

connectionsstring · uuid[]Optional

Source connections the webhook fires for, covering every job of each, including jobs added later. Left out of an update, the current connections are kept.

Responses
200Success
application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

_idstring · uuidRead-onlyRequired
_created_atstring · date-timeRead-onlyRequired
_updated_atstring · date-timeRead-onlyRequired
descriptionstring · max: 255Required
is_activebooleanRequired
methodstring · enumRequired
  • DELETE - DELETE
  • GET - GET
  • PATCH - PATCH
  • POST - POST
  • PUT - PUT
Possible values:
urlstring · max: 1000Required

An http:// or https:// URL. It may contain ${{variables.NAME}}, ${{secrets.NAME}} and ${{erathos.name}} references anywhere, the host included.

headerany · nullableOptional
bodyany · nullableOptional
jobsstring · uuid[]Optional

Jobs the webhook fires for. A webhook needs at least one job or connection. Left out of an update, the current jobs are kept.

connectionsstring · uuid[]Optional

Source connections the webhook fires for, covering every job of each, including jobs added later. Left out of an update, the current connections are kept.

put/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/
PUT /developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "text",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "connections": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
200Success
{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2026-01-01T00:00:00.000Z",
  "_updated_at": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "text",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "connections": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete orchestration webhook

delete
Authorizations
AuthorizationstringRequired
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Responses
204

No response body

No content
delete/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/
DELETE /developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content
PreviousJobs
NextSecrets

Last updated