Manage webhooks

Use this section to add and configure webhooks in evalink talos.

WORK IN PROGRESS

Find all webhooks by Company ID

GET https://talos-app.io/api/webhook-integration/web-hooks/search/findByCompanyId

Use this endpoint to find all the webhooks for a particular company.

Query Parameters

Name	Type	Description
companyId	string	The Company ID, as it is displayed on the evalink talos Web Interface.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

200

{    "{

Find all webhooks by Device ID

GET https://talos-app.io/api/webhook-integration/web-hooks/search/findByCompanyId

Use this endpoint to find all the webhooks for a particular device.

Query Parameters

Name	Type	Description
deviceId	string	The relevant device ID.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

200

{
  "_embedded": {
    "webHooks": [
      {
        "companyId": "string",
        "createdDate": 0,
        "defaultAlarmCode": "string",
        "defaultAlarmValue": true,
        "defaultAlarmZone": "string",
        "defaultTechnical": true,
        "defaultTestMessage": true,
        "description": "string",
        "deviceId": "string",
        "enabled": true,
        "entityStatus": "string",
        "id": "string",
        "invocationInterval": 0,
        "lastInvocationDate": 0,
        "name": "string",
        "nextInvocationTimeoutDate": 0,
        "periodic": true,
        "resumeImmediatly": true,
        "token": "string"
      }
    ]
  },
  "_links": {}
}

create a new webhook

POST https://talos-app.io/api/webhook-integration/web-hooks

Use this endpoint to create a new webhook.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

Request Body

Name	Type	Description
periodic	string
name	string
invocationInterval	string
deviceId	string
description	string
defaultTechnical	string
defaultAlarmCode	string
companyId	string

200

{
  "companyId": "string",
  "createdDate": 0,
  "defaultAlarmCode": "string",
  "defaultAlarmValue": true,
  "defaultAlarmZone": "string",
  "defaultTechnical": true,
  "defaultTestMessage": true,
  "description": "string",
  "deviceId": "string",
  "enabled": true,
  "entityStatus": "string",
  "id": "string",
  "invocationInterval": 0,
  "lastInvocationDate": 0,
  "links": {
    "empty": true
  },
  "name": "string",
  "nextInvocationTimeoutDate": 0,
  "periodic": true,
  "resumeImmediatly": true,
  "token": "string"
}

delete a webhook

DELETE https://talos-app.io/api/webhook-integration/web-hooks/{id}

Use this endpoint to delete a new webhook.

Path Parameters

Name	Type	Description
id	string	The relevant webhook id.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

200

update a webhook

PUT https://talos-app.io/api/webhook-integration/web-hooks/{id}

Use this endpoint to update a new webhook.

Path Parameters

Name	Type	Description
id	string	The relevant webhook ID.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

200

{
  "companyId": "string",
  "createdDate": 0,
  "defaultAlarmCode": "string",
  "defaultAlarmValue": true,
  "defaultAlarmZone": "string",
  "defaultTechnical": true,
  "defaultTestMessage": true,
  "description": "string",
  "deviceId": "string",
  "enabled": true,
  "entityStatus": "string",
  "id": "string",
  "invocationInterval": 0,
  "lastInvocationDate": 0,
  "links": {
    "empty": true
  },
  "name": "string",
  "nextInvocationTimeoutDate": 0,
  "periodic": true,
  "resumeImmediatly": true,
  "token": "string"
}

patch a webhook

PATCH https://talos-app.io/api/webhook-integration/web-hooks/{id}

Use this endpoint to patch a new webhook.

Path Parameters

Name	Type	Description
id	string	The relevant webhook ID.

Headers

Name	Type	Description
Authentication	string	Use 'Bearer' followed by your API token.

200

activate a webhook endpoint

GET https://talos-app.io/api/webhook-integration/incoming/{token}

Use this endpoint to activate a webhook endpoint and notify evalink talos for a particular event.

200

create a webhook endpoint

POST https://talos-app.io/api/webhook-integration/incoming/{token}

Path Parameters

Name	Type	Description
	string

200

activate a periodic webhook endpoint

GET https://talos-app.io/api/webhook-integration/periodic/{token}

Use this endpoint to activate a webhook with periodic invocation

Path Parameters

Name	Type	Description
	string

200

create a periodic webhook endpoint

POST https://talos-app.io/api/webhook-integration/periodic/{token}

Use this endpoint to create a webhook with periodic invocation

Path Parameters

Name	Type	Description
	string

200