Add AGILITY Webhook Integration
- Dina Bennett (Deactivated)
Webhooks allow you to monitor events on your AGILITY account, enabling your integrations to automatically trigger reactions. You can also create Jira tickets via AGILITY webhook events.
Benefits of using webhooks
When building integrations, it's beneficial for your applications to receive real-time events, enabling your backend systems to respond promptly.
To activate webhook events, you need to register webhook endpoints. Once registered, AGILITY sends webhook events to your application as a JSON payload, incorporating an Event object.
Leveraging webhook events is especially valuable for monitoring asynchronous events, such as when a PCAP analysis is completed.
Event overview
When an event occurs, AGILITY generates a new Event object. For example, if you create a new analysis, you receive analysis_done events.
By registering webhook endpoints, you enable AGILITY to automatically send Event objects through POST requests to your application's registered webhook endpoint.
Upon receiving the Event, your application can execute backend actions.
Event types
The following is a list of all the event types we currently send.
New event types may be introduced over time, so when developing and maintaining your code it’s advisable to check back here for updates.
analysis_done: Occurs whenever the processing of an analysis is complete.
Event object
The Event object sent to your webhook endpoint provides a snapshot of the modified object.
Example event payload
The following shows an analysis done event type.
{
"id":"17b1434f-e8d9-4bea-af02-29a346b386a0",
"event_name":"analysis_done",
"created":"2023-11-14T20:46:56.839588",
"data":{
"analysis_id":"c16fa458-c596-496d-8ee5-05761c5fb1b0",
"service_keys":"volte",
"file_path":"myfile.pcap",
"user_id":"00000000-0000-0000-0000-000000000000",
"final_status":"true",
"final_status_ts":"2023-11-14T20:45:25.251409",
"error_message":"",
"count_callflows":2,
"count_results":2,
"unique_service":1,
"unique_nes":16,
"unique_protocols":5,
"unique_procedures":7,
"count_prediction_success":0,
"count_prediction_failure":0,
"count_prediction_warning":2,
"count_prediction_unknown":0,
"created_on":"2023-11-14T20:42:41.761897",
"updated_on":"2023-11-14T20:45:25.176587",
"analyzed_file_paths":[
"myfile.pcap"
]
}
}
Your webhook endpoint receives events for all the subscribed event types according to your configuration. Use the received event_name to determine the specific processing your application needs to perform.
The data object corresponding to each event type varies (in the above example, the data object represents an analysis result). Adapt your application's processing logic accordingly.