Orchestration

List orchestration webhooks

get

Authorizations

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

get

HTTPcURLJavaScriptPython

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": "2025-05-19T05:05:16.413Z",
      "_updated_at": "2025-05-19T05:05:16.413Z",
      "description": "text",
      "is_active": true
    }
  ]
}

Create orchestration webhook

post

Authorizations

Path parameters

workspace_idstring · uuidRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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 · uri · max: 1000Required

headerany | nullableOptional

bodyany | nullableOptional

jobsstring · uuid[]Required

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

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: 231

{
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "https://example.com",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-05-19T05:05:16.413Z",
  "_updated_at": "2025-05-19T05:05:16.413Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "https://example.com",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Retrieve orchestration webhook

get

Authorizations

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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": "2025-05-19T05:05:16.413Z",
  "_updated_at": "2025-05-19T05:05:16.413Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "https://example.com",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Edit orchestration webhook

put

Authorizations

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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 · uri · max: 1000Required

headerany | nullableOptional

bodyany | nullableOptional

jobsstring · uuid[]Required

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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: 231

{
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "https://example.com",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-05-19T05:05:16.413Z",
  "_updated_at": "2025-05-19T05:05:16.413Z",
  "description": "text",
  "is_active": true,
  "method": "DELETE",
  "url": "https://example.com",
  "header": null,
  "body": null,
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete orchestration webhook

delete

Authorizations

Path parameters

_idstring · uuidRequired

workspace_idstring · uuidRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

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