Webhook Notification Event Variable
Ascend's Monitoring and Notifications enables sending a webhook upon Platform events. This webhook can be customized by providing a template. The template will be rendered with a variable named event
, that has the following fields:
Field Name | Type | Description | Example |
---|---|---|---|
eventTime | String, formatted as ISO 8601 UTC with milliseconds | The timestamp of the event |
|
dataService | The Data Service the event is associated with, if applicable | ||
dataflow | The Dataflow the event is associated with, if applicable | See Dataflow Fields | |
environment | String | The subdomain for the Ascend environment |
|
user | The user of the event | See User Fields | |
type | String | The event type |
|
service | String | The Ascend service that logged the event |
|
component | The Component the event is associated with, if applicable | See Component Fields | |
query | The query the event is associated with, if applicable | See Query Fields | |
api | The API fields associated with the event, if applicable | See Api Fields | |
componentStateChange | If the event is a component state change, this key contains the details of the state change. |
Data Service Fields
Field Name | Type | Description | Example |
---|---|---|---|
id | String | The id of the Data Service |
|
name | String | The name of the Data Service (only present if event is from 'api' service) |
|
uri | String | The API path for the Data Service (only present if event is from 'api' service) |
|
uuid | String | The UUID (Ascend Internal ID) for the Data Service |
|
Dataflow Fields
Field Name | Type | Description | Example |
---|---|---|---|
id | String | The id of the Dataflow |
|
name | String | The name of the Dataflow (only present if event is from 'api' service) |
|
uri | String | The API path for the Dataflow (only present if event is from 'api' service) |
|
uuid | String | The UUID (Ascend Internal ID) for the Dataflow |
|
User Fields
Field Name | Type | Description | Example |
---|---|---|---|
String | The email of the user | ||
auth_provider | String | The auth provider the user logged in with |
|
Component Fields
Field Name | Type | Description | Example |
---|---|---|---|
id | String | The id of the Component |
|
name | String | The name of the Component (only present if event is from 'api' service) |
|
uri | String | The API path for the Data Service (only present if event is from 'api' service) |
|
uuid | String | The UUID (Ascend Internal ID) for the Data Service |
|
type | String | The type of the component: |
|
Query Fields
Field Name | Type | Description | Example |
---|---|---|---|
url | String | The url associated with the query | |
query_event | String | The event associated with the query |
Api Fields
Field Name | Type | Description | Example |
---|---|---|---|
request | JSON object with key of | Method represents the HTTP method of the API request |
|
response | JSON object with key of | Status code represents the HTTP response code |
|
Component State Change Fields
Field Name | Type | Description | Example |
---|---|---|---|
message | String | Message associated with the state change |
|
from | The previous state of the component | ||
to | The new state of the component |
Component State Fields
Field Name | Type | Description | Example |
---|---|---|---|
text | String | A text representation of the state |
|
errors | Array of Error Fields | If the component is in error state, the first 10 errors associated with the component | See Error Fields |
Error Fields
Field Name | Type | Description | Example |
---|---|---|---|
description | String | Description of the error | |
timestamp | String | Time the error was recorded | |
backtrace | Array of Strings | The backtrace of the error, if the error corresponds to an error in code logic |
Updated about 1 year ago