Jump to Content

Developer Hub Docs SDK Community Free Trial

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	`2017-11-06T16:39:59.000Z`
dataService	Data Service Fields	The Data Service the event is associated with, if applicable	See Data Service Fields
dataflow	Dataflow Fields	The Dataflow the event is associated with, if applicable	See Dataflow Fields
environment	String	The subdomain for the Ascend environment	`mycompany-staging`
user	User Fields	The user of the event	See User Fields
type	String	The event type	`getSourceState`
service	String	The Ascend service that logged the event	`api`
component	Component Fields	The Component the event is associated with, if applicable	See Component Fields
query	Query Fields	The query the event is associated with, if applicable	See Query Fields
api	Api Fields	The API fields associated with the event, if applicable	See Api Fields
componentStateChange	Component State Change Fields	If the event is a component state change, this key contains the details of the state change.	See Component State Change Fields

Data Service Fields

Field Name	Type	Description	Example
id	String	The id of the Data Service	`data_service_1`
name	String	The name of the Data Service (only present if event is from 'api' service)	`data service 1`
uri	String	The API path for the Data Service (only present if event is from 'api' service)	`api/v1/organizations/data_service_1`
uuid	String	The UUID (Ascend Internal ID) for the Data Service	`b4c88a45-0fe8-4dc1-8b88-5f06cc125940`

Dataflow Fields

Field Name	Type	Description	Example
id	String	The id of the Dataflow	`data_flow_1`
name	String	The name of the Dataflow (only present if event is from 'api' service)	`data flow 1`
uri	String	The API path for the Dataflow (only present if event is from 'api' service)	`/api/v1/organizations/o1/projects/project_1`
uuid	String	The UUID (Ascend Internal ID) for the Dataflow	`8a99372b-db8f-4a0e-a9ff-454eb7ad0e8f`

User Fields

Field Name	Type	Description	Example
email	String	The email of the user	`[email protected]`
auth_provider	String	The auth provider the user logged in with	`okta`

Component Fields

Field Name	Type	Description	Example
id	String	The id of the Component	`source_1`
name	String	The name of the Component (only present if event is from 'api' service)	`Source 1`
uri	String	The API path for the Data Service (only present if event is from 'api' service)	`/api/v1/organizations/o1/project/p1/sources/source_1/state`
uuid	String	The UUID (Ascend Internal ID) for the Data Service	`90a983e8-3829-4238-bae5-26c9c6acc482`
type	String	The type of the component: `source`, `view`, or `sink`	`source`

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`	Method represents the HTTP method of the API request	`{"method": "GET"}`
response	JSON object with key of `status_code`	Status code represents the HTTP response code	`{"status_code": 200}`

Component State Change Fields

Field Name	Type	Description	Example
message	String	Message associated with the state change	`The Component has partitions with errors.`
from	Component State Fields	The previous state of the component	See Component State Fields
to	Component State Fields	The new state of the component	See Component State Fields

Component State Fields

Field Name	Type	Description	Example
text	String	A text representation of the state	`Error`
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 8 months ago

Did this page help you?