BigPanda Callback Service
Improve bidirectional stability for your integrations by enabling BigPanda’s callback service.
The callback service allows BigPanda to verify that an entity (ticket, page, message, etc.) has been successfully created in the target system and that a bidirectional sync has been established.
This service is optional, but highly recommended. It will confirm your integration is configured correctly and prevent any updates from being lost.
When the callback service is enabled, BigPanda will await an API call from the integrated application before sending any incident updates, such as new alerts or alert state changes.
While waiting for a callback, further updates from BigPanda will be “locked” and will not be posted until a response has been received, thus “unlocking” the incident on BigPanda’s side.
Incident updates (additional correlated alerts, incident tag updates, etc.) are queued while BigPanda waits for the incident to be unlocked. If no API call is performed, the share will unlock after 5 minutes and any queued updates will populate.
Optional Feature
The callback service does not have to be enabled for your integration to work. However, if the service is not enabled and updates are sent from BigPanda to an outbound integration while a ticket is being created, it's possible that those updates will be dropped.
Enable the Callback Service
Administrators can enable the callback service for Notifications Webhook integrations by checking the box during the integration installation process.
For the callback service to function properly, your API call must include all of the following data:
Endpoint: https://api.bigpanda.io/resources/v2.1/outbound/callback
Required headers:
Authorization: Bearer
Body:
{
"event_type": "incident#new",
"incident_id": "",
"app_key": ""
}
Response:
{
"status": 200,
"data": {}
}
Event Types
The callback service currently works only with the following event types, which will trigger as defined by your environment’s AutoShare rules:
Event Type | Description |
---|---|
incident#new | A new incident is created in BigPanda. |
incident#updated | A new alert was correlated to the incident OR an alert was resolved within the incident, but not all alerts. |
incident#comment | Comment made on an incident in BigPanda. |
incident#closed | Incident resolved in BigPanda |
incident-tag#upserted | A change was made to an incident tag. |
Disable the Callback Service
- In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
- In the integration details on the right, select Configuration.
- In Setup Instructions, scroll down to the Enable Callback Service step.
- Uncheck the Enable callback service box.
Updated 4 months ago