Overview
\nThe webhook system provided by AURA enables integrators to receive real-time event notifications related to callouts, responders, customers, and subscriptions. By subscribing to specific events, integrators automatically receive data payloads at their specified endpoint URL whenever one of these events occurs. This document outlines the process for configuring, testing, and optimizing webhook integrations.
\nTo test the webhook setup effectively, follow the steps outlined below. While the AURA portal can be utilized for testing, it is strongly recommended to test webhooks directly through the integrated application using the AURA API.
\n1. Set Up a Webhook Endpoint
\nPreferred Method: Use the endpoint of the integrated application configured to receive webhooks.
\nAlternative : If the integrated application cannot be used, create a mock endpoint on Webhook.site and copy the unique URL provided for testing purposes.
\n2. Share Your Test URL and Events
\nProvide the webhook URL that has been set up, along with the list of events intended for subscription.
If the application’s endpoint is being used, ensure it is accessible for webhook testing.
If Webhook.site is being used as a fallback, share the URL generated by the site.
Once this information is received, AURA will configure the webhook to send notifications for the specified events.
3. Trigger Events for Testing
\nRecommended Method: Use the AURA API to trigger events directly from the integrated application. This approach ensures that webhook notifications are tested in a real-world scenario.
Alternative Option: If testing through the integrated application is not immediately feasible, use the Aura portal to tigger events.
4. Monitor Incoming Payloads
\nIf testing through the integrated application, monitor the application’s logs or designated webhook handling logic to verify the reception of payloads.
If using Webhook.site, monitor the incoming payloads displayed on the site for verification.
5. Event Simulation instructions and expected payloads
\nTo facilitate testing,information on triggering each event will be provided. This includes details on API calls and portal simulations to ensure effective testing of webhook functionality.
For each event, the expected payload formats will be provided
AURA's webhook events currently do not use any formal authentication. However, they are sent from a static IP address. As a result, we recommend that any implementation making use of these webhooks validates/white-lists traffic from the listed IP addresses:
\nStaging:
\n34.247.224.1
\n54.194.225.114
\n54.78.115.129
\nProduction:
\n54.220.143.196
\n34.251.163.85
\n34.246.93.167
\nAURA's Webhook configurations can include custom HTTP headers, which are injected into the webhook request. This enables use cases such as including Authorization tokens or other headers required for authentication and routing. If headers are defined, they will be included in the POST request sent to your webhook URL.
You simply need to provide the required headers when setting up the integration with your AURA touchpoint.
\nAll webhook events are sent to the endpoint URL provided. This allows events to be received on any URL specified, tailored to the integrator's infrastructure needs.
\nExample Endpoint URL
\nhttps://your-server-domain.com/api/webhooks/events\n\nSubscriptions can be made to any of the following event types. When an event occurs, a payload will be sent to the specified endpoint.
\nCustomers
\nCREATED_CUSTOMER
UPDATED_CUSTOMER
Subscriptions
\nSUBSCRIPTION_CREATED
SUBSCRIPTION_UPDATED
SUBSCRIPTION_CANCELLED
SUBSCRIPTION_CANCELLED_FAILED
Callouts
\nNEW_CALLOUT -> created
RESPONDER_MANUALLY_DISPATCHED -> Responder Dispatched (Manual Dispatch)
RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA -> Responder Dispatched (Tech Dispatch)
CALLOUT_NO_LONGER_REQUIRES_RESPONSE -> Responder Cancelled
CALLOUT_SOFT_CANCELLED_BY_CUSTOMER -> Customer Soft Cancellation Received
RESPONDER_ARRIVED_ON_SCENE -> Responder Arrived
RESPONDER_COMPLETED -> Responder Completed
CALLOUT_CLOSED -> closed
To use AURA webhooks, please provide the event types from the list above to which you wish to subscribe, along with the URL endpoint.
\nThis section includes payloads for customer-related events. Each event payload describes the event type, with a timestamp indicating when the event took place. Additionally, the payload includes relevant data pertaining to the customer, such as customer identifiers.
\nThe event CREATED_CUSTOMER is for when a new customer gets created.
To Trigger this event a new customer need to be created or registered using the endpoint https://staging-panic.aura.services/panic-api/v2/customers which can be found fully documented on AURA's API-Documentation under the user registrations and management collection.
{\n \"message\": \"CREATED_CUSTOMER\",\n \"customer\": {\n \"id\": 184708,\n \"name\": \"WebhookTest2\",\n \"surname\": \"Test2\",\n \"mobile\": \"+278XXXXXXXXXX\",\n \"email\": \"test22@gmail.com\",\n \"gender\": \"male\",\n \"dateOfBirth\": \"1981-03-06T00:00:00Z\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"businessName\": \"Liberty\",\n \"hasMedicalAid\": true,\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"customerSourceId\": 591,\n \"auth0UserId\": \"bf0eb799-7079-44b7-8aaMNX6-1b594a85b2c7\",\n \"updatedAt\": \"2024-11-04T20:08:12.564Z\",\n \"createdAt\": \"2024-11-04T20:08:12.564Z\",\n \"imageId\": null,\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"stripeCustomerId\": null,\n \"medicalAidPlan\": null,\n \"bloodType\": null,\n \"duressCode\": null,\n \"hasVehicle\": null,\n \"subscriptions\": []\n }\n}\n\nThis event can also be triggered via the AURA portal, navigate to: Cusotmers -> Overview -> ADD. Refer to the snippet below to locate the customer registration interface.
\nThe event UPDATED_CUSTOMER is for when there's an update or an existing customer.
\nTo trigger this event, an existing customer need to be updated using the endpoint:
https://staging-panic.aura.services/panic-api/v2/customers/{customerId}
This endpoint is fully documented in AURA's API-Documentation under the User Registrations and Management collection.
{\n \"message\": \"UPDATED_CUSTOMER\",\n \"customer\": {\n \"id\": 184590,\n \"name\": \"k\",\n \"surname\": \"Test\",\n \"mobile\": \"+2781XXXXXXX\",\n \"gender\": \"Male\",\n \"email\": \"test33@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"customerSourceId\": 591,\n \"dateOfBirth\": \"1981-03-06T00:00:00Z\",\n \"auth0UserId\": \"e0e4c67d-050c-46cMX4-990e-cc711cc483a0\",\n \"imageId\": null,\n \"businessName\": \"test\",\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"stripeCustomerId\": null,\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"medicalAidPlan\": null,\n \"nextOfKinNumber\": \"+27831231234\",\n \"nextOfKinName\": \"Anna\",\n \"bloodType\": null,\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"duressCode\": null,\n \"hasMedicalAid\": true,\n \"hasVehicle\": null,\n \"createdAt\": \"2024-10-11T12:31:17.887Z\",\n \"updatedAt\": \"2024-11-06T12:32:33.034Z\"\n }\n}\n\nThis event can also be triggered via the AURA portal, navigate to: Cusotmers -> Overview -> Click on a Customer in table -> Customer details -> Edit Customer. Refer to the snippet below showing the interface for updating customer information.
\nThis section contains payloads related to subscription events. Each event payload provides detailed information about the specific event type, including a timestamp of when the event occurred.
\nThe event SUBSCRIPTION_CREATED is for when there is a newly created subscription.
To trigger this event, a subscription need to be created using the endpoint:
https://staging-panic.aura.services/panic-api/v2/subscriptions
This endpoint is fully documented in AURA's API-Documentation under the Subscriptions Management collection.
{\n \"message\": \"Successfully activated customer subscription\",\n \"subscription\": {\n \"id\": 318642,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2024-11-06T00:00:00.000Z\",\n \"validTo\": \"2123-05-12T23:59:39.000Z\",\n \"updatedAt\": \"2024-11-06T12:38:44.685Z\",\n \"createdAt\": \"2024-11-06T12:38:44.685Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 184708\n },\n \"dependantLinks\": []\n}\n\nThis event can also be triggered via the AURA portal, navigate to: Cusotmers -> Overview -> Click on a Customer in table -> Subscriptions -> Add subscription. Refer to the snippet below showing the interface for creating a new subscription.
\nThe event SUBSCRIPTION_UPDATED is for when an existing subscribtion gets updated.
To trigger this event, an existing subscription need to be updated using the endpoint:
https://staging-panic.aura.services/panic-api/v2/subscriptions/{MainMembersubscriptionId}
Ensure to include the specific subscriptionId of the subscription you to be updated. This endpoint is fully documented in AURA's API-Documentation under the Subscriptions Management collection.
{\n \"links\": [\n {\n \"id\": 206830,\n \"customerId\": 184707,\n \"subscriptionId\": 318642,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2024-11-06T12:47:18.117Z\",\n \"createdAt\": \"2024-11-06T12:47:18.117Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 318642,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2024-11-06T00:00:00.000Z\",\n \"validTo\": \"2123-05-12T23:59:39.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"createdAt\": \"2024-11-06T12:38:44.685Z\",\n \"updatedAt\": \"2024-11-06T12:47:18.124Z\"\n }\n ],\n \"message\": \"SUBSCRIPTION_UPDATED\"\n}\n\nThe event SUBSCRIPTION_CANCELLED is for when a subscription gets cancelled.
\nTo trigger this event, an existing subscription need to be cancelled using the endpoint:
https://staging-panic.aura.services/panic-api/v2/subscriptions/{MainMembersubscriptionId}
Ensure to include the specific subscriptionId of the subscription to be cancelled. This endpoint is fully documented in AURA's API Documentation under the Subscriptions Management collection.
{\n \"message\": \"SUBSCRIPTION_CANCELLED\",\n \"subscription\": {\n \"id\": 1231231231,\n \"subscriptionTypeId\": 1,\n \"validFrom\": \"2024-11-06T00:00:00.000Z\",\n \"validTo\": \"2123-05-12T23:59:39.000Z\",\n \"updatedAt\": \"2024-11-06T12:38:44.685Z\",\n \"createdAt\": \"2024-11-06T12:38:44.685Z\",\n \"CancelledDate\": \"2024-12-12T23:59:39.000Z\",\n \"CancelledReason\": \"No longer requires subscription\",\n \"subscriptionToken\": null,\n \"customerId\": 1231231\n }\n}\n\nThis event can also be triggered via the AURA portal,navigate to: Cusotmers -> Overview -> Click on a Customer in table -> Subscriptions -> Deactivate. Refer to the snippet below showing the interface for canceling a subscription.
\nThe event SUBSCRIPTION_CANCELLED_FAILED is for when a subscription cancellation fails,
Testing this webhook is not possible, as it requires a failure condition to occur within AURA's ecosystem during the cancellation process.
{\n \"message\": \"SUBSCRIPTION_CANCELLED_FAILED\",\n \"subscription\": {\n \"id\": 1231231231,\n }\n}\n\nThis section contains payloads for callout-related events. Each event payload includes information about the event type, with a timestamp marking when the event was triggered. The payload further includes relevant data regarding the callout, such as callout identifiers, status, assigned responders, or updates during the callout process.
\nThe NEW_CALLOUT event type is for a newly created callout.
To Trigger this event a callout need to be create using the endpoint https://staging-panic.aura.services/panic-api/v2/customers/{{customerId}}/callouts which can be found fully documented on AURA's API-Documentation under the callout request collection.
{\n \"message\": \"NEW_CALLOUT\",\n \"callout\": {\n \"id\": 81290,\n \"cancelledByCustomer\": true,\n \"status\": \"created\",\n \"verified\": null,\n \"verifiedBy\": null,\n \"verifiedAt\": null,\n \"resolvedAt\": null,\n \"loggedAt\": \"2024-11-04T19:45:02.876Z\",\n \"createdAt\": \"2024-11-04T19:45:04.021Z\",\n \"updatedAt\": \"2024-11-04T19:52:46.203Z\",\n \"lastUpdatedBy\": null,\n \"lastUpdatedByClientId\": null,\n \"source\": \"API\",\n \"dispatchRequired\": true,\n \"acknowledged\": false,\n \"firstAcknowledgedBy\": null,\n \"firstAcknowledgedAt\": null,\n \"owned\": false,\n \"ownedBy\": null,\n \"ownedAt\": null,\n \"messageId\": null,\n \"calloutClassificationId\": 2,\n \"calloutLocationTypeId\": null,\n \"internalTest\": false,\n \"responseTypeId\": 1,\n \"parentCalloutId\": null,\n \"regionId\": 1,\n \"inCoverage\": true,\n \"escalated\": false,\n \"escalatedAt\": null,\n \"escalatedBy\": null,\n \"routedControlCentre\": false,\n \"externalRefId\": null,\n \"customerSourceId\": 591,\n \"customerId\": 184569,\n \"integrationUserId\": null,\n \"ownedByUserId\": null,\n \"calloutResponderInRanges\": [],\n \"customer\": {\n \"id\": 182333,\n \"name\": \"Test1\",\n \"surname\": \"TestSurname\",\n \"mobile\": \"+27xxxxxxxxxx\",\n \"gender\": \"Male\",\n \"email\": \"\",\n \"vehicleMake\": \"\",\n \"vehicleModel\": \"\",\n \"vehicleColour\": \"\",\n \"vehicleLicensePlate\": \"\",\n \"customerSourceId\": 591,\n \"dateOfBirth\": \"\",\n \"auth0UserId\": \"0bc72a51de0b2c38e7981075cxd4cc63dc951aea77@clients\",\n \"imageId\": null,\n \"businessName\": \"\",\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"stripeCustomerId\": null,\n \"medicalConditions\": null,\n \"medications\": null,\n \"allergies\": null,\n \"medicalAidNumber\": null,\n \"medicalAidScheme\": null,\n \"medicalAidPlan\": null,\n \"nextOfKinNumber\": null,\n \"nextOfKinName\": null,\n \"bloodType\": null,\n \"familyDoctorPhoneNumber\": null,\n \"medicalOther\": null,\n \"duressCode\": null,\n \"hasMedicalAid\": null,\n \"hasVehicle\": null,\n \"createdAt\": \"2024-10-08T11:09:01.792Z\",\n \"updatedAt\": \"2024-10-08T11:09:58.125Z\"\n },\n \"customerSource\": {\n \"id\": 7911,\n \"description\": \"KhonaSafe\",\n \"createdAt\": \"2024-10-08T10:52:50.675Z\",\n \"updatedAt\": \"2024-10-08T10:54:09.832Z\",\n \"auth0ClientId\": \"0bc72a51de0b2c38e798rf1075c4cc63dc951aea77\",\n \"integrationAuth0ClientId\": null,\n \"supplierId\": null,\n \"partnerId\": 170,\n \"verificationRequired\": true,\n \"deletedAt\": null,\n \"termsAndConditionsUrl\": null,\n \"whatsAppNumber\": null,\n \"whatsAppSubscriptionCallbackURL\": null,\n \"logoUrl\": null,\n \"serverPanicEnabled\": false,\n \"stripeAccountCredentials\": null,\n \"allowSystemEvents\": false,\n \"controlRoomRouting\": false,\n \"sanitisePhoneNumber\": false,\n \"mpesaCredentials\": null,\n \"notifier\": {\n \"config\": [\n {\n \"url\": \"https://webhook.site/37ebcf46-877d-47f7-aa07-f05873027aaf\",\n \"events\": [\n \"NEW_CALLOUT\",\n \"RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA\",\n \"RESPONDER_MANUALLY_DISPATCHED\",\n \"RESPONDER_ARRIVED_ON_SCENE\",\n \"CALLOUT_CLOSED\",\n \"CALLOUT_NO_LONGER_REQUIRES_RESPONSE\",\n \"CALLOUT_EVENTS_CHANGED\",\n \"RESPONDER_LOCATION_CHANGED\"\n ],\n \"method\": \"webhook\"\n }\n ]\n },\n \"payfastCredentials\": null,\n \"pinpointProjectId\": null,\n \"parentCustomerSourceId\": null,\n \"installerIdentifier\": null,\n \"metaData\": null\n },\n \"calloutAdditionalContacts\": [],\n \"calloutGuardingDetail\": null,\n \"calloutAdditionalLocations\": [],\n \"location\": {\n \"calloutId\": 81290,\n \"latitude\": \"-26.10911\",\n \"longitude\": \"28.053037\",\n \"accuracy\": 0\n }\n }\n}\n\nThis event can also be triggered via the AURA portal, navigate to: Dispatch -> Create Callout. below is a snippet of where a callout can be created and similarly be able to trigger this event.
\nThe event RESPONDER_MANUALLY_DISPATCHED type is for when the responder is dispatched manually .
This event cannot be triggered from the integrator's side, as it is managed within AURA's control center. It is triggered when a controller manually dispatches a responder for a callout. Notifications will be sent whenever this occurs.
{\n \"message\": \"RESPONDER_MANUALLY_DISPATCHED\",\n \"calloutExternalRefId\": null,\n \"siteExternalRefId\": null,\n \"callout\": {\n \"id\": 81347,\n \"status\": \"Responder Dispatched\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": true,\n \"customer\": {\n \"id\": 184590,\n \"name\": \"khonaTest\",\n \"surname\": \"Test\",\n \"mobile\": \"+278142xxxx\",\n \"gender\": \"Male\",\n \"email\": \"test33@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1981-03-06T00:00:00Z\",\n \"auth0UserId\": \"e0e4c67d-050c-46c4-990xeme-cc711cc483a0\",\n \"imageId\": null,\n \"businessName\": \"test\",\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 81347,\n \"status\": \"Responder Dispatched\",\n \"createdAt\": \"2024-11-12T21:54:59.218Z\",\n \"calloutClassification\": {\n \"id\": 1,\n \"value\": \"REAL\"\n },\n \"verified\": true,\n \"responseType\": {\n \"id\": 1,\n \"value\": \"SECURITY\"\n },\n \"incidentDetails\": \"\",\n \"typeOfEmergency\": null,\n \"incidentcategory\": null,\n \"calloutCurrentLocation\": {\n \"latitude\": \"-26.10911\",\n \"longitude\": \"28.053037\",\n \"formattedAddress\": \"12 Alice Ln, Sandhurst, Sandton, 2196, South Africa\",\n \"region\": \"Gauteng\",\n \"city\": \"Sandton\",\n \"country\": \"South Africa\",\n \"description\": null,\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": \"2024-11-12T22:02:23.782Z\",\n \"responderArrivedAt\": null,\n \"responderCompletedAt\": null,\n \"responder\": null,\n \"supplier\": {\n \"id\": 65,\n \"name\": \"xxxxx\"\n },\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}\n\nThe event RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA type is for when the responder is dispatched via tech(Automatically)
This event cannot be triggered from the integrator's side. It is triggered automatically when a responder is dispatched through AURA system's technology for a callout associated with the integrator's customer source.
{\n \"message\": \"RESPONDER_ACKNOWLEDGED_CALLOUT\",\n \"calloutExternalRefId\": null,\n \"siteExternalRefId\": null,\n \"callout\": {\n \"id\": 81394,\n \"status\": \"Responder Dispatched\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": true,\n \"customer\": {\n \"id\": 184733,\n \"name\": \"G\",\n \"surname\": \"Test\",\n \"mobile\": \"+31XXXXXXXX\",\n \"gender\": \"\",\n \"email\": null,\n \"vehicleMake\": \"\",\n \"vehicleModel\": \"\",\n \"vehicleColour\": \"\",\n \"vehicleLicensePlate\": \"\",\n \"dateOfBirth\": null,\n \"auth0UserId\": \"tuBcheITw4XT45ty1UYyo0xBnjXevR9E0mDB\",\n \"imageId\": null,\n \"businessName\": null,\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 81394,\n \"status\": \"Responder Dispatched\",\n \"createdAt\": \"2024-11-14T11:47:55.928Z\",\n \"calloutClassification\": {\n \"id\": 1,\n \"value\": \"REAL\"\n },\n \"verified\": true,\n \"responseType\": {\n \"id\": 1,\n \"value\": \"SECURITY\"\n },\n \"incidentDetails\": null,\n \"typeOfEmergency\": null,\n \"incidentcategory\": null,\n \"calloutCurrentLocation\": {\n \"latitude\": \"52.3169189\",\n \"longitude\": \"4.745924599999999\",\n \"formattedAddress\": \"Amsterdam Airport Schiphol (AMS), Aankomstpassage, Schiphol, Netherlands\",\n \"region\": \"Noord-Holland\",\n \"city\": \"Schiphol\",\n \"country\": \"Netherlands\",\n \"description\": \" \",\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": \"2024-11-14T11:48:10.343Z\",\n \"responderArrivedAt\": null,\n \"responderCompletedAt\": null,\n \"responder\": {\n \"id\": 158,\n \"callsign\": \"testy\",\n \"vehicleMake\": \"toyota\",\n \"vehicleModel\": \"hilux\",\n \"vehicleColour\": \"red\",\n \"vehicleLicensePlate\": \"derp\",\n \"responseOfficer\": null,\n \"responderLocation\": {\n \"latitude\": \"52.33073418404093\",\n \"longitude\": \"4.8890331758808685\",\n \"accuracy\": 24,\n \"provider\": null,\n \"region\": null,\n \"city\": null,\n \"country\": null\n }\n },\n \"supplier\": {\n \"id\": 46,\n \"name\": \"AURA Responder\"\n },\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}\n\nThe Event CALLOUT_NO_LONGER_REQUIRES_RESPONSE is for when the callout gets cancelled
\nTo trigger this event,An active callout need to be cancelled using the endpoint:
https://staging-panic.aura.services/panic-api/v2/callouts/{calloutId}/dismiss
This endpoint is fully documented in AURA's API Documentation under the Callouts Management collection.
{\n \"message\": \"CALLOUT_NO_LONGER_REQUIRES_RESPONSE\",\n \"calloutExternalRefId\": null,\n \"siteExternalRefId\": null,\n \"callout\": {\n \"id\": 81295,\n \"status\": \"Responder Cancelled\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": false,\n \"customer\": {\n \"id\": 1845784656,\n \"name\": \"khona\",\n \"surname\": \"Test\",\n \"mobile\": \"+27XXXXXXXX\",\n \"gender\": \"Male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1981-03-06T00:00:00Z\",\n \"auth0UserId\": \"e0e4c67d-050c-46c4-Me1990ge-cc711cc483a0\",\n \"imageId\": null,\n \"businessName\": \"test\",\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 81295,\n \"status\": \"Responder Cancelled\",\n \"createdAt\": \"2024-11-06T09:31:33.941Z\",\n \"calloutClassification\": {\n \"id\": 2,\n \"value\": \"TEST\"\n },\n \"verified\": false,\n \"responseType\": {\n \"id\": 1,\n \"value\": \"SECURITY\"\n },\n \"incidentDetails\": null,\n \"typeOfEmergency\": null,\n \"incidentcategory\": null,\n \"calloutCurrentLocation\": {\n \"latitude\": \"-26.10911\",\n \"longitude\": \"28.053037\",\n \"formattedAddress\": \"12 Alice Ln, Sandhurst, Sandton, 2196, South Africa\",\n \"region\": \"Gauteng\",\n \"city\": \"Sandton\",\n \"country\": \"South Africa\",\n \"description\": null,\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": null,\n \"responderArrivedAt\": null,\n \"responderCompletedAt\": null,\n \"responder\": null,\n \"supplier\": null,\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}\n\nThis event can also be triggered via the AURA portal, navigate to: Dispatch -> Expand on a Callout -> Cancel Callout. Refer to the relevant section in the portal for canceling a callout.
\nThe event RESPONDER_ARRIVED_ON_SCENE is for when the responder arrives on the scene
This event cannot be triggered from the integrator's side. It is automatically triggered within AURA's system when a responder reaches the specified location.
{\n \"message\": \"RESPONDER_ARRIVED_ON_SCENE\",\n \"calloutExternalRefId\": null,\n \"siteExternalRefId\": null,\n \"callout\": {\n \"id\": 81347,\n \"status\": \"Responder Arrived\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": true,\n \"customer\": {\n \"id\": 1845934350,\n \"name\": \"khona\",\n \"surname\": \"Test\",\n \"mobile\": \"+2781XXXXXXXX\",\n \"gender\": \"Male\",\n \"email\": \"test33@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1981-03-06T00:00:00Z\",\n \"auth0UserId\": \"e0e4c67d-050c-46c4-990e-cc7110Ecc483a0\",\n \"imageId\": null,\n \"businessName\": \"test\",\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 81347,\n \"status\": \"Responder Arrived\",\n \"createdAt\": \"2024-11-12T21:54:59.218Z\",\n \"calloutClassification\": {\n \"id\": 1,\n \"value\": \"REAL\"\n },\n \"verified\": true,\n \"responseType\": {\n \"id\": 1,\n \"value\": \"SECURITY\"\n },\n \"incidentDetails\": \"\",\n \"typeOfEmergency\": null,\n \"incidentcategory\": null,\n \"calloutCurrentLocation\": {\n \"latitude\": \"-26.10911\",\n \"longitude\": \"28.053037\",\n \"formattedAddress\": \"12 Alice Ln, Sandhurst, Sandton, 2196, South Africa\",\n \"region\": \"Gauteng\",\n \"city\": \"Sandton\",\n \"country\": \"South Africa\",\n \"description\": null,\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": \"2024-11-12T22:02:23.782Z\",\n \"responderArrivedAt\": \"2024-11-12T22:03:00.785Z\",\n \"responderCompletedAt\": null,\n \"responder\": null,\n \"supplier\": {\n \"id\": 65,\n \"name\": \"xxxxxxxxxxxx\"\n },\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}\n\nThe CALLOUT_CLOSED event is triggered when a callout is closed. This event cannot be triggered from the integrator's side. It is triggered within Aura’s system when a callout is marked as closed by the Control Center or a responder.
\n{\n \"message\": \"CALLOUT_CLOSED\",\n \"calloutExternalRefId\": null,\n \"siteExternalRefId\": null,\n \"callout\": {\n \"id\": 81392,\n \"status\": \"closed\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": true,\n \"customer\": {\n \"id\": 184733,\n \"name\": \"Test1\",\n \"surname\": \"MTest\",\n \"mobile\": \"+31XXXXXXXXXX\",\n \"gender\": \"\",\n \"email\": null,\n \"vehicleMake\": \"\",\n \"vehicleModel\": \"\",\n \"vehicleColour\": \"\",\n \"vehicleLicensePlate\": \"\",\n \"dateOfBirth\": null,\n \"auth0UserId\": \"tuBcheITw4XT45ty1UYyBnjXvTR9E0xmMmDB\",\n \"imageId\": null,\n \"businessName\": null,\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 81392,\n \"status\": \"closed\",\n \"createdAt\": \"2024-11-14T11:35:34.992Z\",\n \"calloutClassification\": {\n \"id\": 1,\n \"value\": \"REAL\"\n },\n \"verified\": true,\n \"responseType\": {\n \"id\": 1,\n \"value\": \"SECURITY\"\n },\n \"incidentDetails\": \"test\",\n \"typeOfEmergency\": {\n \"id\": 1,\n \"description\": \"Security\"\n },\n \"incidentcategory\": {\n \"id\": 12,\n \"description\": \"Unarmed Robbery\"\n },\n \"calloutCurrentLocation\": {\n \"latitude\": \"52.3169189\",\n \"longitude\": \"4.745924599999999\",\n \"formattedAddress\": \"Amsterdam Airport Schiphol (AMS), Aankomstpassage, Schiphol, Netherlands\",\n \"region\": \"Noord-Holland\",\n \"city\": \"Schiphol\",\n \"country\": \"Netherlands\",\n \"description\": \" \",\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": \"2024-11-14T11:37:35.845Z\",\n \"responderArrivedAt\": \"2024-11-14T11:42:01.603Z\",\n \"responderCompletedAt\": \"2024-11-14T11:42:12.529Z\",\n \"responder\": {\n \"id\": 158,\n \"callsign\": \"testy\",\n \"vehicleMake\": \"toyota\",\n \"vehicleModel\": \"hilux\",\n \"vehicleColour\": \"red\",\n \"vehicleLicensePlate\": \"derp\",\n \"responseOfficer\": null,\n \"responderLocation\": {\n \"latitude\": \"52.33077758825415\",\n \"longitude\": \"4.889027894084576\",\n \"accuracy\": 0,\n \"provider\": null,\n \"region\": null,\n \"city\": null,\n \"country\": null\n }\n },\n \"supplier\": {\n \"id\": 46,\n \"name\": \"AURA Responder\"\n },\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}\n\nThis endpoint allows you to register a new webhook notifier with the specified configuration. It is used to send notifications to a designated URL when specific events occur in AURA's ecosystem.
\nMethod: POST
Endpoint: https://staging-panic.aura.services/panic-api/v2/notifiers/webhooks
The request body should be in JSON format and must include the following parameters:
\nurl (string): The endpoint to which the notifications will be sent. This should be a valid URL.
\nevents (array of strings): A list of events that will trigger the webhook. For example, you can specify events like NEW_CALLOUT.
method (string): Use 'webhook'.
\nheaders (object): Custom headers to be included in the webhook request. You may add whichever headers you would like appended to the webhook callback to your url.
\nExample of a request body:
\n{\n \"url\": \"https://iambutatesthook.com/ab\",\n \"events\": [\"NEW_CALLOUT\"],\n \"method\": \"webhook\",\n \"headers\": {\n \"content-type\": \"meep\",\n \"authorization\": \"Bearer xxxx\"\n }\n}\n\nUpon a successful request, the API will return a response with a status code of 200. The response will be in JSON format and will contain the following structure:
\nmessage (string): A message indicating the result of the request (may be empty).
\nnotifier (object): Contains the configuration details of the registered notifier.
\nconfig (array of objects): An array of notifier configurations, each including:
\nurl (string): The registered URL for the notifier.
\nevents (array of strings): The events that trigger the notifier.
\nmethod (string): The HTTP method used for the notifier.
\nheaders (object): The headers associated with the notifier.
\ncontent-type (string): The content type of the request.
\nauthorization (string): The authorization token used.
\nignorePath (boolean): Indicates whether to ignore the path in the request.
\n