{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bf7ec10e-29d8-41ec-af91-49d9dc758fbf","name":"Webhook Documentation","description":"**Overview**\n\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.\n\n\n\n# Testing Guide for Webhook Setup\n\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.\n\n---\n\n1\\. **Set Up a Webhook Endpoint**\n\n**Preferred Method:** Use the endpoint of the integrated application configured to receive webhooks.\n\n**Alternative :** If the integrated application cannot be used, create a mock endpoint on [Webhook.site](https://webhook.site/) and copy the unique URL provided for testing purposes.\n\n**2\\. Share Your Test URL and Events**\n\nProvide the webhook URL that has been set up, along with the list of events intended for subscription. \nIf the application’s endpoint is being used, ensure it is accessible for webhook testing. \nIf [Webhook.site](https://webhook.site/) is being used as a fallback, share the URL generated by the site. \nOnce this information is received, AURA will configure the webhook to send notifications for the specified events.\n\n**3\\. Trigger Events for Testing**\n\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. \nAlternative Option: If testing through the integrated application is not immediately feasible, use the Aura portal to tigger events.\n\n**4.** **Monitor Incoming Payloads**\n\nIf testing through the integrated application, monitor the application’s logs or designated webhook handling logic to verify the reception of payloads. \nIf using [Webhook.site](https://webhook.site/), monitor the incoming payloads displayed on the site for verification.\n\n**5\\. Event Simulation instructions and expected payloads**\n\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. \nFor each event, the expected payload formats will be provided\n\n# Authentication\n\nAURA'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:\n\n**Staging:**\n\n- 34.247.224.1\n \n- 54.194.225.114\n \n- 54.78.115.129\n \n\n**Production:**\n\n- 54.220.143.196\n \n- 34.251.163.85\n \n- 34.246.93.167\n \n\n# Custom Headers Support\n\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.\n\nYou simply need to provide the required headers when setting up the integration with your AURA touchpoint.\n\n# Configuring Your Endpoint URL\n\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.\n\nExample Endpoint URL\n\n```\nhttps://your-server-domain.com/api/webhooks/events\n\n ```\n\n# **Event Subscription And** Event Types\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.\n\n**Customers**\n\n- `CREATED_CUSTOMER`\n \n- `UPDATED_CUSTOMER`\n \n\n**Subscriptions**\n\n- `SUBSCRIPTION_CREATED`\n \n- `SUBSCRIPTION_UPDATED`\n \n- `SUBSCRIPTION_CANCELLED`\n \n- `SUBSCRIPTION_CANCELLED_FAILED`\n \n\n**Callouts**\n\n- `NEW_CALLOUT` -> created\n \n- `RESPONDER_MANUALLY_DISPATCHED` -> Responder Dispatched (Manual Dispatch)\n \n- `RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA` -> Responder Dispatched (Tech Dispatch)\n \n- `CALLOUT_NO_LONGER_REQUIRES_RESPONSE` -> Responder Cancelled\n \n- `CALLOUT_SOFT_CANCELLED_BY_CUSTOMER` -> Customer Soft Cancellation Received\n \n- `RESPONDER_ARRIVED_ON_SCENE` -> Responder Arrived\n \n- `RESPONDER_COMPLETED` -> Responder Completed\n \n- `CALLOUT_CLOSED` -> closed\n \n\nTo use AURA webhooks, please provide the event types from the list above to which you wish to subscribe, along with the URL endpoint.\n\n# Customers\n\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.\n\n## CREATED_CUSTOMER\n\nThe event **CREATED_CUSTOMER** is for when a new customer gets created. \nTo Trigger this event a new customer need to be created or registered using the endpoint [https://staging-panic.aura.services/panic-api/v2/customers](https://personal.aura.services/#5e7e7c35-e48a-4265-8cd9-625ba2f17741) which can be found fully documented on AURA's [API-Documentation](https://personal.aura.services/) under the user **registrations and management** collection.\n\n``` json\n{\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\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.\n\n\n\n## UPDATED_CUSTOMER\n\nThe event **UPDATED_CUSTOMER** is for when there's an update or an existing customer.\n\nTo trigger this event, an existing customer need to be updated using the endpoint: \n[https://staging-panic.aura.services/panic-api/v2/customers/{customerId}](https://personal.aura.services/#5ff1489a-6478-4305-b4f4-714e08b7bdff) \nThis endpoint is fully documented in AURA's [API-Documentation](https://personal.aura.services/) under the **User Registrations and Management** collection.\n\n``` json\n{\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\n ```\n\nThis event can also be triggered via the [AURA portal](https://staging-portal.aura.services/), 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.\n\n\n\n# Subscriptions\n\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.\n\n## SUBSCRIPTION_CREATED\n\nThe event **SUBSCRIPTION_CREATED** is for when there is a newly created subscription. \nTo trigger this event, a subscription need to be created using the endpoint: \n[https://staging-panic.aura.services/panic-api/v2/subscriptions](https://personal.aura.services/#35ba3b87-48cd-4428-9c64-02a3c4862101) \nThis endpoint is fully documented in AURA's [API-Documentation](https://personal.aura.services/) under the **Subscriptions Management** collection.\n\n``` json\n{\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\n ```\n\nThis event can also be triggered via the [AURA portal](https://staging-portal.aura.services/), 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.\n\n\n\n## SUBSCRIPTION_UPDATED\n\nThe event **SUBSCRIPTION_UPDATED** is for when an existing subscribtion gets updated. \nTo trigger this event, an existing subscription need to be updated using the endpoint: \n[https://staging-panic.aura.services/panic-api/v2/subscriptions/{MainMembersubscriptionId}](https://personal.aura.services/#4d95d354-5229-425c-bd50-75ba11d822ea) \nEnsure to include the specific subscriptionId of the subscription you to be updated. This endpoint is fully documented in AURA's [API-Documentation](https://personal.aura.services/) under the Subscriptions Management collection.\n\n``` json\n{\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\n ```\n\n## SUBSCRIPTION_CANCELLED\n\nThe event **SUBSCRIPTION_CANCELLED** is for when a subscription gets cancelled.\n\nTo trigger this event, an existing subscription need to be cancelled using the endpoint: \n[https://staging-panic.aura.services/panic-api/v2/subscriptions/{MainMembersubscriptionId}](https://personal.aura.services/#45241215-e374-4c6c-810c-56599625f0da) \nEnsure to include the specific subscriptionId of the subscription to be cancelled. This endpoint is fully documented in AURA's [API Documentation](https://personal.aura.services/) under the **Subscriptions Management** collection.\n\n``` json\n{\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\n ```\n\nThis event can also be triggered via the [AURA portal](https://staging-portal.aura.services/),navigate to: Cusotmers -> Overview -> Click on a Customer in table -> Subscriptions -> Deactivate. Refer to the snippet below showing the interface for canceling a subscription.\n\n\n\n## SUBSCRIPTION_CANCELLED_FAILED\n\nThe event **SUBSCRIPTION_CANCELLED_FAILED** is for when a subscription cancellation fails, \nTesting this webhook is not possible, as it requires a failure condition to occur within AURA's ecosystem during the cancellation process.\n\n``` json\n{\n \"message\": \"SUBSCRIPTION_CANCELLED_FAILED\",\n \"subscription\": {\n \"id\": 1231231231,\n }\n}\n\n ```\n\n# Callouts\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.\n\n## NEW_CALLOUT\n\nThe **NEW_CALLOUT** event type is for a newly created callout. \nTo Trigger this event a callout need to be create using the endpoint [https://staging-panic.aura.services/panic-api/v2/customers/{{customerId}}/callouts](https://personal.aura.services/#b2bb6d7e-db3a-48f9-b21b-0dea76d4856b) which can be found fully documented on AURA's [API-Documentation](https://personal.aura.services/) under the **callout request** collection.\n\n``` json\n{\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\n ```\n\nThis event can also be triggered via the [AURA portal](https://staging-portal.aura.services/), navigate to: Dispatch -> Create Callout. below is a snippet of where a callout can be created and similarly be able to trigger this event.\n\n\n\n## RESPONDER_MANUALLY_DISPATCHED\n\nThe event **RESPONDER_MANUALLY_DISPATCHED** type is for when the responder is dispatched manually . \nThis 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\n``` json\n{\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\n ```\n\n## RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA\n\nThe event **RESPONDER_ACKNOWLEDGED_CALLOUT_WITH_ETA** type is for when the responder is dispatched via tech(Automatically) \nThis 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\n``` json\n{\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\n ```\n\n## CALLOUT_NO_LONGER_REQUIRES_RESPONSE\n\nThe Event **CALLOUT_NO_LONGER_REQUIRES_RESPONSE** is for when the callout gets cancelled\n\nTo trigger this event,An active callout need to be cancelled using the endpoint: \n[https://staging-panic.aura.services/panic-api/v2/callouts/{calloutId}/dismiss](https://personal.aura.services/#afb18a37-4d09-401b-a19f-2ff509b5be8c) \nThis endpoint is fully documented in AURA's [API Documentation](https://personal.aura.services/) under the **Callouts Management** collection.\n\n``` json\n{\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\n ```\n\nThis event can also be triggered via the [AURA portal](https://staging-portal.aura.services/), navigate to: Dispatch -> Expand on a Callout -> Cancel Callout. Refer to the relevant section in the portal for canceling a callout.\n\n\n\n## RESPONDER_ARRIVED_ON_SCENE\n\nThe event **RESPONDER_ARRIVED_ON_SCENE** is for when the responder arrives on the scene \nThis 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\n``` json\n{\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\n ```\n\n## CALLOUT_CLOSED\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``` json\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\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38829647","collectionId":"bf7ec10e-29d8-41ec-af91-49d9dc758fbf","publishedId":"2sAY55ZHNu","public":true,"publicUrl":"https://hooks.aura.services","privateUrl":"https://go.postman.co/documentation/38829647-bf7ec10e-29d8-41ec-af91-49d9dc758fbf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-12-03T10:56:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://aura.services/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://hooks.aura.services/view/metadata/2sAY55ZHNu"}