Skip to content

Notifications ​


The portal will notify through webhook events or by email on events happening.

The email is well formatted with all the elements inside the event data

Generic events ​

Trigger on create distributor event ​

This event is triggered when a user creates as a distributor on the portal.

  • Event name: create_distributor
  • API: POST /{session_holder}/distributors
  • Event data:
json
{
  "data": {
    "billing_id": "dwh5",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 5,
    "name": "dist-wh5"
  },
  "event": "create_distributor",
  "owner": "owner.username"
}

Trigger on update distributor event ​

This event is triggered when a user updates as a distributor on the portal.

  • Event name: update_distributor
  • API: PUT /{session_holder}/distributors/{uuid}
  • Event data:
json
{
  "data": {
    "billing_id": "dwh5",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 5,
    "name": "dist-wh5"
  },
  "event": "update_distributor",
  "owner": "owner.username"
}

Trigger on delete distributor event ​

This event is triggered when a user deletes as a distributor on the portal.

  • Event name: delete_distributor
  • API: DELETE /{session_holder}/distributors/{uuid}
  • Event data:
json
{
  "data": {
    "billing_id": "dwh5",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936"
  },
  "event": "delete_distributor",
  "owner": "owner.username"
}

Trigger on create reseller event ​

This event is triggered when a user creates as a reseller on the portal.

  • Event name: create_reseller
  • API: POST /{session_holder}/resellers
  • Event data:
json
{
  "data": {
    "billing_id": "rwh7",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 10,
    "name": "res-wh7",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6"
  },
  "event": "create_reseller",
  "owner": "owner.username"
}

Trigger on update reseller event ​

This event is triggered when a user updates as a reseller on the portal.

  • Event name: update_reseller
  • API: POST /{session_holder}/resellers
  • Event data:
json
{
  "data": {
    "billing_id": "rwh7",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 10,
    "name": "res-wh7",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6"
  },
  "event": "update_reseller",
  "owner": "owner.username"
}

Trigger on delete reseller event ​

This event is triggered when a user deletes a reseller on the portal.

  • Event name: delete_reseller
  • API: DELETE /{session_holder}/resellers/{uuid}
  • Event data:
json
{
  "data": {
    "billing_id": "rwh7",
    "distributor_uuid": "512c3ca9-ea77-4eb5-9c4c-dc0c2d24d2c9",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936"
  },
  "event": "delete_reseller",
  "owner": "owner.username"
}

Trigger on create tenant event ​

This event is triggered when a user creates a tenant on the portal.

  • Event name: create_tenant
  • API: POST /{session_holder}/tenants
  • Event data:
json
{
  "data": {
    "billing_id": "twh2",
    "distributor_uuid": "",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 15,
    "name": "ten-wh2",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6",
    "tenant_uuid": "bcf29923-e8b8-4801-aad7-cabc54277854"
  },
  "event": "create_tenant",
  "owner": "owner.username"
}

Trigger on update tenant event ​

This event is triggered when a user updates a tenant on the portal.

  • Event name: update_tenant
  • API: PUT /{session_holder}/tenants/{uuid}
  • Event data:
json
{
  "data": {
    "billing_id": "twh2",
    "distributor_uuid": "",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "markup": 15,
    "name": "ten-wh2",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6",
    "tenant_uuid": "bcf29923-e8b8-4801-aad7-cabc54277854"
  },
  "event": "update_tenant",
  "owner": "owner.username"
}

Trigger on delete tenant event ​

This event is triggered when a user deletes a tenant on the portal.

  • Event name: delete_tenant
  • API: DELETE /{session_holder}/tenants/{uuid}
  • Event data:
json
{
  "data": {
    "billing_id": "twh2",
    "distributor_uuid": "",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "reseller_uuid": "992921d2-5577-4706-abfc-fad8e4032db6",
    "tenant_uuid": "bcf29923-e8b8-4801-aad7-cabc54277854"
  },
  "event": "delete_tenant",
  "owner": "owner.username"
}

Trigger on create subscription event ​

This event is triggered when a user creates a subscription on the portal.

  • Event name: create_subscription
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions
  • Event data:
json
{
  "data": {
    "billing_id": "swh3",
    "distributor_uuid": "a0ebd55f-963a-485f-a6b8-74b897858b75",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "name": "sub-wh3",
    "reseller_uuid": "8b342360-87be-469b-80c2-b14814f8b3c9",
    "subscription_id": "96",
    "tenant_uuid": "00432eef-2854-4f4b-9977-1bfdef720e36"
  },
  "event": "create_subscription",
  "owner": "owner.username"
}

Trigger on update subscription event ​

This event is triggered when a user updates a subscription on the portal.

  • Event name: update_subscription
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}
  • Event data:
json
{
  "data": {
    "billing_id": "swh3",
    "distributor_uuid": "a0ebd55f-963a-485f-a6b8-74b897858b75",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "name": "sub-wh3",
    "reseller_uuid": "8b342360-87be-469b-80c2-b14814f8b3c9",
    "subscription_id": "96",
    "tenant_uuid": "00432eef-2854-4f4b-9977-1bfdef720e36",
    "suspension_profile_id": null
  },
  "event": "update_subscription",
  "owner": "owner.username"
}

Trigger on delete subscription event ​

This event is triggered when a user deletes a subscription on the portal.

  • Event name: delete_subscription
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}
  • Event data:
json
{
  "data": {
    "billing_id": "swh3",
    "distributor_uuid": "a0ebd55f-963a-485f-a6b8-74b897858b75",
    "group_uuid": "f394f577-8799-4f43-a4f5-81a7953f8936",
    "reseller_uuid": "8b342360-87be-469b-80c2-b14814f8b3c9",
    "subscription_id": "96",
    "tenant_uuid": "00432eef-2854-4f4b-9977-1bfdef720e36"
  },
  "event": "delete_subscription",
  "owner": "owner.username"
}

Trigger on add phone number to subscription event ​

This event is triggered when a user adds a phone number to a subscription on the portal.

  • Event name: add_number_subscription
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/numbers
  • Event data:
    json
    {
      "data": {
        "countryCode": "+27",
        "distributor_uuid": "",
        "group_name": "Netaxis",
        "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
        "ranges": [
          [
            102852001,
            102852001
          ]
        ],
        "reseller_name": "Netaxis Reseller",
        "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
        "subscription_id": 2,
        "subscription_name": "Direct Routing DEV",
        "tenant_name": "Netaxis DEV",
        "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9"
      },
      "event": "add_number_subscription",
    "owner": "owner.username"
    }

Trigger on update_subscription_number event ​

This event is triggered when a user updates a subscription's number on the portal.

  • Event name: update_subscription_number
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/numbers/{number}
  • Event data:
json
{
  "match_info": {
    "session_holder": "node4_fusion_dev",
    "uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a"
  },
  "body": {
    "data": {
      "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
      "distributor_uuid": "",
      "reseller_uuid": "867599fd-195b-4cd3-99b8-44a021799559",
      "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
      "subscription_id": 1,
      "address": "Rue du Trône, 12, Bruxelles, Belgium",
      "full_number": "+31302004494",
      "number_type": null,
      "rewrite_number": null,
      "diversion_number": null,
      "status": null,
      "address_verified": false,
      "disaster_recovery_number": null,
      "source": null
    },
    "event": "update_subscription_number",
    "owner": "owner.username"
  }
}

Trigger on remove numbers subscription event ​

This event is triggered when a user removes a phone number from a subscription on the portal.

  • Event name: remove_number_subscription
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/numbers/{number}
  • Event data:
    json
    {
      "data": {
        "distributor_uuid": "",
        "group_name": "Netaxis",
        "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
        "numbers": [
          {
            "countryCode": "+27",
            "nsn": 102852001
          }
        ],
        "reseller_name": "Netaxis Reseller",
        "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
        "subscription_id": 2,
        "subscription_name": "Direct Routing DEV",
        "tenant_name": "Netaxis DEV",
        "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9"
      },
      "event": "remove_number_subscription",
    "owner": "owner.username"
    }

Trigger on remove completely numbers subscription event ​

This event is triggered when a user removes completely a phone number from a subscription on the portal.

  • Event name: remove_quarantine_number_subscription
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/numbers/{number}
  • Event data:
    json
    {
      "data": {
        "distributor_uuid": "",
        "group_name": "Netaxis",
        "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
        "numbers": [
          {
            "countryCode": "+27",
            "nsn": 102852001
          }
        ],
        "reseller_name": "Netaxis Reseller",
        "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
        "subscription_id": 2,
        "subscription_name": "Direct Routing DEV",
        "tenant_name": "Netaxis DEV",
        "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9"
      },
      "event": "remove_quarantine_number_subscription",
               "owner": "owner.username"
    }

Trigger on create a new order event ​

This event is triggered when a user creates a new order on the portal.

  • Event name: create_order
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/orders
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "order_id": "120",
    "products": [{
      "sku": "MS-SIP-1",
      "quantity": 3
    }]
  },
  "event": "create_order",
  "owner": "owner.username"
}

Trigger on delete an order event ​

This event is triggered when a user deletes an order on the portal.

  • Event name: remove_order
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/orders
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "order_id": "120",
    "products": [{
      "sku": "MS-SIP-1",
      "quantity": 2
    }]
  },
  "event": "remove_order",
  "owner": "owner.username"
}

MS Teams specific events ​

Trigger on create MS user event ​

This event is triggered when a user creates an MS user on the portal.

  • Event name: create_ms_user
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/users
  • Event data:
json
{
  "data": {
    "display_name": "Test",
    "distributor_uuid": "",
    "domain": "netaxisdev.onmicrosoft.com",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "location": "",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 91,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "user_id": "aac428a8-60a3-447c-bb6d-cf83a0b0ef53",
    "upn": "paciTest@netaxisdev.onmicrosoft.com",
    "username": "paciTest",
    "customer_licences": []
  },
  "event": "create_ms_user",
  "owner": "owner.username"
}

Trigger on update MS user event ​

This event is triggered when a user updates an MS user on the portal.

  • Event name: update_ms_user
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/users/{ms_user_id}/properties
  • Event data:
json
{
  "data": {
    "display_name": "Test 2",
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "location": "",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 91,
    "user_id": "aac428a8-60a3-447c-bb6d-cf83a0b0ef53",
    "upn": "paciTest@netaxisdev.onmicrosoft.com",
    "username": "paciTest",
    "domain": "netaxisdev.onmicrosoft.com",
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "groups": [],
    "vrp": "",
    "licenses": [],
    "customer_licences": ["call bundle"]
  },
  "event": "update_ms_user",
  "owner": "owner.username"
}

Trigger on delete MS user event ​

This event is triggered when a user deletes an MS user on the portal.

  • Event name: delete_ms_user
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{sub_id}/msteams/users/{ms_user_id}
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 91,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "user_id": "d6e7453e-9f4d-4af4-a08b-861f0ed99e54",
    "display_name": "Test 2",
    "upn": "paciTest@netaxisdev.onmicrosoft.com",
    "username": "paciTest",
    "domain": "netaxisdev.onmicrosoft.com",
    "location": "",
    "customer_licences": ["call bundle"]
  },
  "event": "delete_ms_user",
  "owner": "owner.username"
}

Trigger on add number to MS user event ​

This event is triggered when a user adds a number to MS user on the portal.

  • Event name: add_number_ms_user
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/users/{ms_user_id}
  • Event data:
json
{
  "data": {
    "display_name": "Richard Lobster",
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "phoneNumber": "+27102851553",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "customer_licences": ["call bundle"],
    "consumed_fusion_seats": "+1"
  },
  "event": "add_number_ms_user,",
  "owner": "owner.username"
}

Trigger on delete number from MS user event ​

This event is triggered when a user removes a number from MS user on the portal.

  • Event name: remove_number_ms_user
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/users/{ms_user_id}
  • Event data:
json
{
  "data": {
    "display_name": "Richard Lobster",
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "phoneNumber": "",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "customer_licences": ["call bundle"],
    "consumed_fusion_seats": "-1"
  },
  "event": "remove_number_ms_user",
  "owner": "owner.username"
}

Trigger on create MS resource account event ​

This event is triggered when a user creates an MS resource account on the portal.

  • Event name: create_ms_ra
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/resource_accounts
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "display_name": "Richard Lobster",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "account_type": "call-queue",
    "customer_licences": []
  },
  "event": "create_ms_ra",
  "owner": "owner.username"
}

Trigger on update MS resource account event ​

This event is triggered when a user updates an MS resource account on the portal.

  • Event name: update_ms_ra
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/resource_accounts/{id}
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "display_name": "Richard Lobster",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "account_type": "call-queue",
    "customer_licences": ["call bundle"]
  },
  "event": "update_ms_ra",
  "owner": "owner.username"
}

Trigger on delete MS resource account event ​

This event is triggered when a user deletes an MS resource account on the portal.

  • Event name: delete_ms_ra
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/resource_accounts/{id}
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "display_name": "Richard Lobster",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "customer_licences": ["call bundle"]
  },
  "event": "delete_ms_ra",
  "owner": "owner.username"
}

Trigger on add number to resource account event ​

This event is triggered when a user adds number to MS resource account on the portal.

  • Event name: add_number_ms_ra
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/resource_accounts/{id}
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "phoneNumber": "+27102851557",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "display_name": "Richard Lobster",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "customer_licences": ["call bundle"],
    "consumed_fusion_seats": "+1"
  },
  "event": "add_number_ms_ra",
  "owner": "owner.username"
}

Trigger on delete number from resource account event ​

This event is triggered when a user deletes a number from resource account on the portal.

  • Event name: remove_number_ms_ra
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/resource_accounts/{id}
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "display_name": "Richard Lobster",
    "upn": "RichardLobster@netaxisdev.onmicrosoft.com",
    "user_id": "7b0b3347-fd1a-4c2e-acf8-927063fffb6b",
    "customer_licences": ["call bundle"],
    "consumed_fusion_seats": "-1"
  },
  "event": "remove_number_ms_ra",
  "owner": "owner.username"
}

Trigger on onboarding step 1 - add domain event ​

This event is triggered during the MS Teams' tenant onboarding, at step 1 (add domain) on the portal.

  • Event name: ms_onboarding_add_domain
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/wizard
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "domain": "netaxis.cloud"
  },
  "event": "onboarding_add_domain",
  "owner": "owner.username"
}

Trigger on onboarding step 2 - create dummy user event ​

This event is triggered during the MS Teams' tenant onboarding step 2 (create dummy user) on the portal.

  • Event name: ms_onboarding_create_user
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/wizard
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "dummy_user": "<upn_user>"
  },
  "event": "onboarding_create_user",
  "owner": "owner.username"
}

Trigger on onboarding step 3 - add DR data event ​

This event is triggered during the MS Teams' tenant onboarding step 3 (add DR data) on the portal.

  • Event name: ms_onboarding_add_dr_data
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/msteams/wizard
  • Event data:
json
{
  "data": {
    "distributor_uuid": "",
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "subscription_id": 2,
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "details": {
      "sbc": "7cpem15sla.idal2.test.fusion.netaxis.cloud", 
      "status": "created"
    }
  },
  "event": "onboarding_add_dr_data",
  "owner": "owner.username"
}

Trunking events ​

Trigger on create trunk group event ​

This event is triggered when a user creates a trunk group on the portal.

  • Event name: sip_create_trunkgroup
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": "1",
    "uuid": "0921a230-e173-4a6c-9af6-67841a517c80",
    "name": "Test TG 3",
    "cfa_active": false,
    "cfa_destination": "",
    "cfnr_active": true,
    "cfnr_destination": "",
    "cld_format": "e164",
    "clg_format": "e164",
    "unscreened_calls_block": false,
    "unscreened_calls_overwrite_with_pilot": true
  },
  "event": "sip_create_trunkgroup",
  "owner": "owner.username"
}

Trigger on update trunk group event ​

This event is triggered when a user updates a trunk group on the portal.

  • Event name: sip_update_trunkgroup
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "uuid": "db44e2de-fd63-4d87-ac07-b0a99af9e51b",
    "name": "Test TG 1",
    "cld_format": "e164",
    "clg_format": "e164",
    "pilot": "+3225409943"
  },
  "event": "sip_update_trunkgroup",
  "owner": "owner.username"
}

Trigger on create peer trunk group event ​

This event is triggered when a user creates a trunk group on the portal.

  • Event name: sip_create_peer_trunkgroup
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": "1",
    "uuid": "0921a230-e173-4a6c-9af6-67841a517c80",
    "name": "Test TG 3",
    "cfa_active": false,
    "cfa_destination": "",
    "cfnr_active": true,
    "cfnr_destination": "",
    "cld_format": "e164",
    "clg_format": "e164",
    "unscreened_calls_block": false,
    "unscreened_calls_overwrite_with_pilot": true
  },
  "event": "sip_create_peer_trunkgroup"
}

Trigger on update peer trunk group event ​

This event is triggered when a user updates a trunk group on the portal.

  • Event name: sip_update_peer_trunkgroup
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "uuid": "db44e2de-fd63-4d87-ac07-b0a99af9e51b",
    "name": "Test TG 1",
    "cld_format": "e164",
    "clg_format": "e164",
    "pilot": "+3225409943"
  },
  "event": "sip_update_peer_trunkgroup"
}

Trigger on suspend trunk group event ​

This event is triggered when a user suspends a trunk group on the portal.

  • Event name: sip_suspend_trunkgroup
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/suspend
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "uuid": "db44e2de-fd63-4d87-ac07-b0a99af9e51b",
    "name": "Test TG 1",
    "incomingCalls": true
  },
  "event": "sip_update_trunkgroup",
  "owner": "owner.username"
}

Trigger on delete trunk group event ​

This event is triggered when a user deletes a trunk group on the portal.

  • Event name: sip_delete_trunkgroup
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "uuid": "db44e2de-fd63-4d87-ac07-b0a99af9e51b",
    "name": "Test TG 1"
  },
  "event": "sip_delete_trunkgroup",
  "owner": "owner.username"
}

Trigger on add number trunkgroup event ​

This event is triggered when a user adds numbers to a trunk group on the portal.

  • Event name: sip_add_number_trunkgroup
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/numbers
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "867599fd-195b-4cd3-99b8-44a021799559",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "trunkgroup_name": "IDAL trunk",
    "trunkgroup_uuid": "2ad922c4-a962-4458-be57-d0a39afcd549",
    "numbers": [
      "+3225409941",
      "+3225409942",
      "+3225409943"
    ]
  },
  "event": "sip_add_number_trunkgroup",
  "owner": "owner.username"
}

Trigger on remove number trunkgroup event ​

This event is triggered when a user removes numbers from a trunk group on the portal.

  • Event name: sip_remove_number_trunkgroup
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/numbers
  • Event data:
json
{
  "data": {
    "group_uuid": "aaf9dba1-9469-40fa-be50-22298d68010d",
    "distributor_uuid": "",
    "reseller_uuid": "cae902b4-2307-41ef-b554-43a12c63cc97",
    "tenant_uuid": "53fd92c7-fbef-44fd-af76-d92334432ac9",
    "subscription_id": 2,
    "trunkgroup_name": "Test Stijn",
    "trunkgroup_uuid": "097c6663-a0c7-487b-b57f-b6e09402b8bb",
    "numbers": [
      "+3225409948"
    ]
  },
  "event": "sip_remove_number_trunkgroup",
  "owner": "owner.username"
}

Trigger on add access trunk to trunkgroup event ​

This event is triggered when a user creates an access trunk on the portal.

  • Event name: sip_add_access_trunk_trunkgroup
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks
  • Event data:
json
{
  "data": {
    "accessTrunks": [
      {
        "authPassword": "********",
        "authRequired": true,
        "authUsername": "myUsername",
        "id": 23,
        "ipWhitelist": "127.0.0.1",
        "name": "RBEN Test New Yeah",
        "pop": {
          "id": 1,
          "inboundCalls": false,
          "name": "Wakefield",
          "outboundCalls": true,
          "transport": "UDP"
        },
        "primaryPeerIp": "10.1.2.3",
        "primaryPeerPort": 5678,
        "priority": 20,
        "uuid": "cceebf8f-bea5-4be4-bbd3-75d9eb9bd50e",
        "weight": 12
      },
      {
        "authPassword": "********",
        "authRequired": true,
        "authUsername": "myUsername",
        "id": 24,
        "ipWhitelist": "127.0.0.1",
        "name": "RBEN Test New Yeah",
        "pop": {
          "id": 2,
          "inboundCalls": true,
          "name": "Northampton",
          "outboundCalls": false,
          "transport": "UDP"
        },
        "primaryPeerIp": "10.1.2.3",
        "primaryPeerPort": 5678,
        "priority": 20,
        "uuid": "be29f273-f83e-433a-8b48-e6fba315603b",
        "weight": 12
      }
    ]
  },
  "event": "sip_add_access_trunk_trunkgroup",
  "owner": "owner.username"
}

Trigger on update access trunk from trunkgroup event ​

This event is triggered when a user updates an access trunk on the portal.

  • Event name: sip_update_access_trunk_trunkgroup
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks/{access_trunk_id}
  • Event data:
json
{
  "data": {
    "authRequired": false,
    "distributor_uuid": "",
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "ipWhitelist": "127.0.0.1,10.1.2.34",
    "name": "Modified Access Trunk Test",
    "pop": {
      "inboundCalls": true,
      "name": "Northampton",
      "outboundCalls": true,
      "transport": "UDP"
    },
    "primaryPeerIp": "10.1.1.2",
    "primaryPeerPort": 1234,
    "priority": 5,
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "subscription_id": 4,
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "trunkgroup_name": "rben_trunkgroup1",
    "trunkgroup_uuid": "39b03776-bf6d-4902-8150-f99cbe97845e",
    "uuid": "b1dc7749-5456-4fdf-ac84-ec02e0147743",
    "weight": 8
  },
  "event": "sip_update_access_trunk_trunkgroup",
  "owner": "owner.username"
}

Trigger on remove access trunk from trunkgroup event ​

This event is triggered when a user deletes an access trunk on the portal.

  • Event name: sip_remove_access_trunk_trunkgroup
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/access_trunks/{access_trunk_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "b7f784a2-87f6-483b-a5ac-bef566c6da19",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 4,
    "trunkgroup_name": "rben_trunkgroup1",
    "trunkgroup_uuid": "39b03776-bf6d-4902-8150-f99cbe97845e",
    "name": "RBEN Test New",
    "uuid": "b1dc7749-5456-4fdf-ac84-ec02e0147743"
  },
  "event": "sip_remove_access_trunk_trunkgroup",
  "owner": "owner.username"
}

Trigger on add peer trunk to trunkgroup event ​

This event is triggered when a user creates a peer trunk on the portal.

  • Event name: sip_add_peer_trunk_trunkgroup
  • API: POST /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/peer_trunks
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "867599fd-195b-4cd3-99b8-44a021799559",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "billingId": "peer:test",
    "extra": {
      "name": "Peer Test"
    },
    "name": "Peer Test",
    "pop": {
      "inboundCalls": false,
      "outboundCalls": true,
      "id": 1
    },
    "id": 113,
    "uuid": "a355b573-c1f1-49fc-bfb7-3d32ecc45860",
  },
  "event": "sip_add_peer_trunk_trunkgroup",
  "owner": "owner.username"
}

Trigger on update peer trunk from trunkgroup event ​

This event is triggered when a user updates a peer trunk on the portal.

  • Event name: sip_update_peer_trunk_trunkgroup
  • API: PUT /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/peer_trunks/{peer_trunk_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "867599fd-195b-4cd3-99b8-44a021799559",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "name": "Peer Test Mod",
    "pop": {
      "id": 2,
      "inboundCalls": true,
      "outboundCalls": false
    },
    "billingId": "peer:test_mod",
    "extra": {
      "name": "Peer Test Mod"
    },
    "uuid": "a355b573-c1f1-49fc-bfb7-3d32ecc45860",
    "id": 114
  },
  "event": "sip_update_peer_trunk_trunkgroup",
  "owner": "owner.username"
}

Trigger on remove peer trunk from trunkgroup event ​

This event is triggered when a user deletes a peer trunk on the portal.

  • Event name: sip_remove_peer_trunk_trunkgroup
  • API: DELETE /{session_holder}/tenants/{uuid}/subscriptions/{subscription_id}/trunkgroups/{trunkgroup_id}/peer_trunks/{peer_trunk_id}
  • Event data:
json
{
  "data": {
    "group_uuid": "adb26c5a-38bf-469c-87e2-20445fa1e64d",
    "distributor_uuid": "",
    "reseller_uuid": "867599fd-195b-4cd3-99b8-44a021799559",
    "tenant_uuid": "21fb665e-c3db-40c5-a50c-65a9d4be540a",
    "subscription_id": 1,
    "name": "Peer Test Mod",
    "uuid": "a355b573-c1f1-49fc-bfb7-3d32ecc45860",
    "id": 115
  },
  "event": "sip_remove_peer_trunk_trunkgroup",
  "owner": "owner.username"
}