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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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-04-03T06:40:45.786Z",
      "_updated_at": "2025-04-03T06:40:45.786Z",
      "description": "text",
      "is_active": true
    }
  ]
}

Create orchestration webhook

post

Authorizations

Path parameters

workspace_idstring · uuidrequired

Body

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

_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

Available options:

urlstring · uri · max: 1000required

headerany | nullableoptional

bodyany | nullableoptional

rulesobject[]required

jobsstring · uuid[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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

201

201

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:40:45.786Z",
  "_updated_at": "2025-04-03T06:40:45.786Z",
  "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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:40:45.786Z",
  "_updated_at": "2025-04-03T06:40:45.786Z",
  "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

_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

Available options:

urlstring · uri · max: 1000required

headerany | nullableoptional

bodyany | nullableoptional

rulesobject[]required

jobsstring · uuid[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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

200

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2025-04-03T06:40:45.786Z",
  "_updated_at": "2025-04-03T06:40:45.786Z",
  "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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/' \
  --header 'Authorization: YOUR_API_KEY'

204

204

No body

No response body