Orchestration

List orchestration webhooks

GEThttps://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/

Authorization

ApiKeyAuth

Path parameters

workspace_id*string (uuid)

Query parameters

Response

200

Body

application/json

countinteger

Example: 50

next_pagenullable integer

Example: 3

previous_pagenullable integer

Example: 1

page_sizeinteger

Example: 10

total_pagesinteger

Example: 5

current_pageinteger

Example: 2

resultsarray of OrchestrationWebhooks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": "2024-12-04T18:54:06.036Z",
      "_updated_at": "2024-12-04T18:54:06.036Z",
      "description": "text",
      "is_active": false
    }
  ]
}

Create orchestration webhook

POSThttps://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/

Authorization

ApiKeyAuth

Path parameters

workspace_id*string (uuid)

Body

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

_id* id

_created_at* created at

_updated_at* updated at

description*string

is_active*boolean

method*MethodEnum (enum)

• DELETE - DELETE
• GET - GET
• PATCH - PATCH
• POST - POST
• PUT - PUT

DELETEGETPATCHPOSTPUT

url*string (uri)

headernullable any

bodynullable any

rules*array of OrchestrationWebhookRule (object)

jobs*array of string (uuid)

Response

201

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

description*string

is_active*boolean

method*MethodEnum (enum)

• DELETE - DELETE
• GET - GET
• PATCH - PATCH
• POST - POST
• PUT - PUT

DELETEGETPATCHPOSTPUT

url*string (uri)

headernullable any

bodynullable any

rules*array of OrchestrationWebhookRule (object)

jobs*array of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "_created_at": "2024-12-04T18:54:06.036Z",
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_updated_at": "2024-12-04T18:54:06.036Z",
      "description": "text",
      "is_active": false,
      "jobs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "method": "DELETE",
      "rules": [
        {
          "operation": "EQUAL",
          "value": "text",
          "variable_name": "JOB_ID"
        }
      ],
      "url": "https://example.com"
    }),
});
const data = await response.json();

Response

201

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T18:54:06.036Z",
  "_updated_at": "2024-12-04T18:54:06.036Z",
  "description": "text",
  "is_active": false,
  "method": "DELETE",
  "url": "https://example.com",
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Retrieve orchestration webhook

GEThttps://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Response

200

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

description*string

is_active*boolean

method*MethodEnum (enum)

• DELETE - DELETE
• GET - GET
• PATCH - PATCH
• POST - POST
• PUT - PUT

DELETEGETPATCHPOSTPUT

url*string (uri)

headernullable any

bodynullable any

rules*array of OrchestrationWebhookRule (object)

jobs*array of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T18:54:06.036Z",
  "_updated_at": "2024-12-04T18:54:06.036Z",
  "description": "text",
  "is_active": false,
  "method": "DELETE",
  "url": "https://example.com",
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Edit orchestration webhook

PUThttps://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Body

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

_id* id

_created_at* created at

_updated_at* updated at

description*string

is_active*boolean

method*MethodEnum (enum)

• DELETE - DELETE
• GET - GET
• PATCH - PATCH
• POST - POST
• PUT - PUT

DELETEGETPATCHPOSTPUT

url*string (uri)

headernullable any

bodynullable any

rules*array of OrchestrationWebhookRule (object)

jobs*array of string (uuid)

Response

200

Body

application/json

_id* id

_created_at* created at

_updated_at* updated at

description*string

is_active*boolean

method*MethodEnum (enum)

• DELETE - DELETE
• GET - GET
• PATCH - PATCH
• POST - POST
• PUT - PUT

DELETEGETPATCHPOSTPUT

url*string (uri)

headernullable any

bodynullable any

rules*array of OrchestrationWebhookRule (object)

jobs*array of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "_created_at": "2024-12-04T18:54:06.036Z",
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_updated_at": "2024-12-04T18:54:06.036Z",
      "description": "text",
      "is_active": false,
      "jobs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "method": "DELETE",
      "rules": [
        {
          "operation": "EQUAL",
          "value": "text",
          "variable_name": "JOB_ID"
        }
      ],
      "url": "https://example.com"
    }),
});
const data = await response.json();

Response

200

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_created_at": "2024-12-04T18:54:06.036Z",
  "_updated_at": "2024-12-04T18:54:06.036Z",
  "description": "text",
  "is_active": false,
  "method": "DELETE",
  "url": "https://example.com",
  "rules": [
    {
      "variable_name": "JOB_ID",
      "operation": "EQUAL",
      "value": "text"
    }
  ],
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete orchestration webhook

DELETEhttps://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/

Authorization

ApiKeyAuth

Path parameters

_id*string (uuid)

workspace_id*string (uuid)

Response

204

No response body

Request

JavaScriptCurlPython

const response = await fetch('https://api.erathos.com/developers/workspaces/{workspace_id}/orchestration/webhooks/{_id}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();