Webhooks

Orders Update Webhook

This webhook will notify you when orders change state. Right now, this confirms when all order types - with the exception of orders creating a brand new Private APN - complete. You can also expect to receive an event when cease orders are set to pending. As this feature is in beta, further changes may be made.

Setup

1. Log in to Mobile Manager and navigate to the Settings section
2. Enter the URL of your desired webhook into the 'Orders Update Webhook' field and click Save Settings

Response

            {
                "OrderId": "00000000-0000-0000-0000-000000000000",
                "State": 0,
                "Type": 0,
                "SimId": "00000000-0000-0000-0000-000000000000",
                "PoolId": "00000000-0000-0000-0000-000000000000",
                "APNId": "00000000-0000-0000-0000-000000000000"
            }
            

Order Types

• Activate = 0
• Cease = 1
• Bar = 2
• BoltOn = 3
• TariffChange = 4
• SimSwap = 5
• UnBar = 6
• ConditionalBar = 7
• CPE = 8
• PoolRegrade = 9
• PoolActivation = 10
• PoolCease = 11
• APNActivation = 12
• APNChangeRequest = 13
• FullBar = 14

Order States

• Open = 0
• Complete = 1
• Failed = 2
• Stalled = 3
• Cancelled = 4
• Pending = 5

Alert Webhooks

An alert can be configured to send events to a webhook as part of its On and Off actions.

Setup

1. Log in to Mobile Manager and navigate to the Alerts section
2. Create or edit an Alert, select the Action as 'Webhook' and enter into the Action Data the URL of the webhook.

Event Data

            {
                "AlertName": "Alert Name 1",
                "AlertId": "00000000-0000-0000-0000-000000000000",
                "AlertTargetType": "SIM",
                "AlertTriggerType": "On",
                "AlertStatName": "SIM.%USED",
                "AlertConditionalValue": "75",
                "AlertCondition": "GreaterThan",
                "AlertTriggerValue": "85",
                "EntityId": "00000000-0000-0000-0000-000000000000"
            }
            

* AlertTargetType indicates whether this alert refers to a "SIM" or a "Pool"

* AlertTriggerType "On" or "Off" indicates the Alert turning on or turning off

* EntityId refers to the Id of the ''AlertTargetType' i.e "SIM" or "Pool"

For example: This event data would represent the alert turning On, because a SIM has used 85% of its data, which is over the set 75% threshold.