Requirements
An active Farsight® admin account
Authorized API key
Limitations
Get All Realtime Webhooks (GET /v1/realtime/webhooks)
You can retrieve a list of all real-time webhooks using this API. Once authorized, this call will return all webhooks.
All parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
Limit | integer | No | The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25. |
Offset | integer | No | The index of the first item to return. Must be 0 or greater. It is set to 0 by default. |
Create a New Realtime Webhooks (POST /v1/realtime/webhooks)
You can retrieve a list of all real-time webhooks using this API. Once authorized, this call will return all webhooks.
All parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
assetGroupId | integer | Yes | The ID of the asset group you want to monitor and receive webhook responses for. |
signals | string[array] | No | The asset signals that you want to monitor. |
url | string | No | The URL of your service used to consume the webhook response. |
headers | strings | No | Any additional headers to be sent to your service url. |
Get One Realtime Webhook (GET /v1/realtime/webhooks{id})
All parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
id | integer | Yes | The ID of the webhook. |
Delete One Realtime Webhook (DELETE /v1/realtime/webhooks{id})
You can retrieve a list of all real-time webhooks using this API. Once authorized, this call will return all webhooks.
All parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
id | integer | Yes | The ID of the webhook. |
Update One Realtime Webhook (PUT /v1/realtime/webhooks{id})
All parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
id | integer | Yes | The ID of the webhook. |
assetGroupId | integer | Yes | The ID of the asset group you want to monitor and receive webhook responses for. |
signals | string[array] | No | The asset signals that you want to monitor. |
url | string | No | The URL of your service used to consume the webhook response. |
headers | strings | No | Any additional headers to be sent to your service url. |
Related Content