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 id String The id of the Data Service data_service_1name String The name of the Data Service (only present if event is from 'api' service) data service 1uri String The API path for the Data Service (only present if event is from 'api' service) api/v1/organizations/data_service_1uuid String The UUID (Ascend Internal ID) for the Data Service b4c88a45-0fe8-4dc1-8b88-5f06cc125940
Field Name Type Description Example id String The id of the Dataflow data_flow_1name String The name of the Dataflow (only present if event is from 'api' service) data flow 1uri 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
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
Field Name Type Description Example id String The id of the Component source_1name String The name of the Component (only present if event is from 'api' service) Source 1uri 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/stateuuid String The UUID (Ascend Internal ID) for the Data Service 90a983e8-3829-4238-bae5-26c9c6acc482type String The type of the component: source, view, or sink source
Field Name Type Description Example url String The url associated with the query query_event String The event associated with the query
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}
Field Name Type Description Example text String A text representation of the state Errorerrors Array of Error Fields If the component is in error state, the first 10 errors associated with the component See 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
