iPilot supports the ability to configure a Webhook URL at the Platform Provider level that will receive HTTPS POST requests containing billable events in JSON format. Events listed with \"RT\" indicate they trigger as soon as the event happens. Otherwise the event will fire once per day at a predefined time.
\nWebhook JSON Object Schema
\nThe following properties are available depending on the type of event that is triggered
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36603369","collectionId":"bd0d18f8-0d98-4d27-8806-d6681a47f9c4","publishedId":"2sA3rwLDRV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"145ca4"},"publishDate":"2024-08-02T09:22:11.000Z"},"item":[{"name":"Billing Events Webhook","item":[{"name":"Call Path Order RT","id":"36db8ee6-4c7f-413b-a992-34b836e6183c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 2779,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"Placed new order\",\r\n \"order_type\": \"MSTEAMS DID NEW\",\r\n \"event_type\": \"increase\",\r\n \"pon_number\": \"NUW2024070145\",\r\n \"call_path_count\": 10,\r\n \"external_customer_account_id\": \"1565\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When an order is created to increase or decrease the number of Call Paths this event is triggered in real-time.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"36db8ee6-4c7f-413b-a992-34b836e6183c"},{"name":"Phone Number Order RT","id":"2cfbc169-c518-4000-9811-713cec980839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 2779,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"Placed new order\",\r\n \"order_type\": \"MSTEAMS DID NEW\",\r\n \"event_type\": \"add\",\r\n \"pon_number\": \"NUW2024070145\",\r\n \"complete_number_count\": 10,\r\n \"external_customer_account_id\": \"1565\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When an order is created for new phone numbers this event is triggered in real-time.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2cfbc169-c518-4000-9811-713cec980839"},{"name":"Port Number Order RT","id":"dd75b13f-70ab-448e-9a67-f094d83733d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 1615,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"assign\",\r\n \"event_type\": \"add\",\r\n \"complete_number_count\": 2,\r\n \"external_customer_account_id\": \"7246\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When an order is created to increase or decrease the number of Call Paths this event is triggered in real-time.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"dd75b13f-70ab-448e-9a67-f094d83733d6"},{"name":"Phone Number Routed RT","id":"2237e112-c4ef-43f2-84ee-9f9c55d326dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 196,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"ASSIGNED DEFAULT OUTBOUND ROUTE\",\r\n \"number_assigned\": 13,\r\n \"external_customer_account_id\": \"6527\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When a Phone Number is routed to an outbound route group this event will be sent to the configured webhook url. This event happens in real-time.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2237e112-c4ef-43f2-84ee-9f9c55d326dc"},{"name":"Call Forwarding","id":"49b43642-90ee-4572-b82b-410dfe797f80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 261,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"callforward\",\r\n \"event_type\": \"remove\",\r\n \"number_count\": 1,\r\n \"external_customer_account_id\": \"\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When a call forward is added or removed this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"49b43642-90ee-4572-b82b-410dfe797f80"},{"name":"Dynamic Emergency Services","id":"9ff0bec9-3fcb-4e3c-a50d-a525b3750de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 2198,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"dynamicemergencyservices\",\r\n \"event_type\": \"add\",\r\n \"module\": \"msteam\",\r\n \"number_count\": 1,\r\n \"external_customer_account_id\": \"7938\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When dynamic emergency services is added or removed this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9ff0bec9-3fcb-4e3c-a50d-a525b3750de9"},{"name":"Emergency Services","id":"cdcd4139-6761-4778-8a91-c2a2d11fa6e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\":2229,\r\n \"event_object\":\"customer\",\r\n \"event_action\":\"emergencyservices\",\r\n \"event_type\":\"add\",\r\n \"module\":\"webex\",\r\n \"number_count\":1,\r\n \"external_customer_account_id\":\"\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When static emergency services is added or removed this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"cdcd4139-6761-4778-8a91-c2a2d11fa6e9"},{"name":"International Calling","id":"d45e2ab7-5a6a-4fd9-a176-db23ae5e31ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 341,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"internationalcalling\",\r\n \"event_type\": \"add\",\r\n \"number_count\": 1,\r\n \"external_customer_account_id\": \"6709\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When international calling is added or removed this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d45e2ab7-5a6a-4fd9-a176-db23ae5e31ad"},{"name":"Inbound CNAM","id":"55e8368d-764c-4213-809f-c9d4e48a933e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 2354,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"inboundcnam\",\r\n \"event_type\": \"enable\",\r\n \"number_count\": 1,\r\n \"external_customer_account_id\": \"8144\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When inbound CNAM is enabled or disabled this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"55e8368d-764c-4213-809f-c9d4e48a933e"},{"name":"Outbound CNAM","id":"18f9375b-511c-40cd-986b-ac65dd2a5e5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 1619,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"outboundcnam\",\r\n \"event_type\": \"enable\",\r\n \"number_count\": 5,\r\n \"external_customer_account_id\": \"7248\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When outbound CNAM is enabled or disabled this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"18f9375b-511c-40cd-986b-ac65dd2a5e5b"},{"name":"SMS","id":"6bb64f21-5316-48bd-a4f5-5029d9cca831","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 261,\r\n \"event_object\": \"customer\",\r\n \"event_action\": \"sms\",\r\n \"event_type\": \"enable\",\r\n \"number_count\": 1,\r\n \"external_customer_account_id\": \"\",\r\n \"reseller_own_sku\":\"4353\",\r\n \"platform_own_sku\":\"3333\",\r\n \"system_sku\":\"1234\"\r\n}","options":{"raw":{"language":"json"}}},"description":"When SMS is enabled or disabled this event will fire at scheduled intervals per day.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"6bb64f21-5316-48bd-a4f5-5029d9cca831"}],"id":"be843414-79ed-4262-a176-b0e5eb376b3e","description":"This is the billing events webhook related to any billable event inside of ipilot.
\n","_postman_id":"be843414-79ed-4262-a176-b0e5eb376b3e"},{"name":"Account Events Webhook","item":[{"name":"Customer Account Event RT","id":"d755249c-32a1-44aa-a295-9c4dab318e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"account_id\": 1111,\r\n \"event_action\": \"updated | new | deleted\",\r\n \"event_object\": \"customer\",\r\n \"updated_fields\": \"any field from the iPilot customer object, see the iPilot API for more details.\"\r\n}","options":{"raw":{"language":"json"}}},"description":"For any changes made to a customer account, new customer added or a customer that is deleted/removed this event will fire.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d755249c-32a1-44aa-a295-9c4dab318e3c"},{"name":"Site Event RT","id":"c92e37ef-dc76-4315-a663-bc017fcf971c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Account_id\": 3238,\r\n \"site_id\": 4230,\r\n \"site_name\": \"Site ABC\",\r\n \"event_action\": \"Add | Update | Delete\",\r\n \"event_object\": \"Site\",\r\n \"updated_fields\": [\r\n \"Address\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"description":"For any changes made to a site, new sites added or a site that is deleted/removed this event will fire.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c92e37ef-dc76-4315-a663-bc017fcf971c"}],"id":"d68da60c-9145-443b-aa7d-1fadd9ad06bb","_postman_id":"d68da60c-9145-443b-aa7d-1fadd9ad06bb","description":""}]}