evalink talos
  • evalink talos API Documentation
  • Get started
    • 1. Create a free evalink talos account
    • 2. Create a test set-up in evalink talos
    • 3. About REST – The Basics
    • 4. Get Postman
    • 5. Create your first API Token in evalink talos
    • 6. Make your first REST API call
  • Alarm API
    • Send alarms using simple webhooks
    • Send alarms with content using webhooks and header attachments
    • Send alarms using REST
    • Query alarms
  • Management API
    • Manage users
    • Manage devices
    • Manage groups
    • Manage contacts
    • Manage schedules
    • Manage virtual receivers
    • Manage webhooks
    • Manage workflows
Powered by GitBook
On this page
  • Find all webhooks by Company ID
  • Find all webhooks by Device ID
  • create a new webhook
  • delete a webhook
  • update a webhook
  • patch a webhook
  • activate a webhook endpoint
  • create a webhook endpoint
  • activate a periodic webhook endpoint
  • create a periodic webhook endpoint

Was this helpful?

  1. Management API

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.

{    "{

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.

{
  "_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

{
  "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.

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.

{
  "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.

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.

create a webhook endpoint

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

Path Parameters

Name
Type
Description

string

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

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

PreviousManage virtual receiversNextManage workflows

Last updated 4 years ago

Was this helpful?