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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

Trigger on `create a new order` event

This event is triggered when a user creates a 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"
}

Trigger on `delete an order` event

This event is triggered when a user deletes a 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"
}

MS Teams specific events

Trigger on `create MS user` event

This event is triggered when a user creates a 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": "PACI 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"
}

Trigger on `update MS user` event

This event is triggered when a user updates a 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": "PACI 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"
}

Trigger on `delete MS user` event

This event is triggered when a user deletes a 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": "PACI Test 2",
    "upn": "paciTest@netaxisdev.onmicrosoft.com",
    "username": "paciTest",
    "domain": "netaxisdev.onmicrosoft.com",
    "location": "",
    "customer_licences": ["call bundle"]
  },
  "event": "delete_ms_user"
}

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,"
}

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"
}

Trigger on `create MS resource account` event

This event is triggered when a user creates a 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"
}

Trigger on `update MS resource account` event

This event is triggered when a user updates a 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"
}

Trigger on `delete MS resource account` event

This event is triggered when a user deletes a 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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

Notifications ​

Generic events ​

Trigger on create distributor event ​

Trigger on update distributor event ​

Trigger on delete distributor event ​

Trigger on create reseller event ​

Trigger on update reseller event ​

Trigger on delete reseller event ​

Trigger on create tenant event ​

Trigger on update tenant event ​

Trigger on delete tenant event ​

Trigger on create subscription event ​

Trigger on update subscription event ​

Trigger on delete subscription event ​

Trigger on create a new order event ​

Trigger on delete an order event ​

MS Teams specific events ​

Trigger on create MS user event ​

Trigger on update MS user event ​

Trigger on delete MS user event ​

Trigger on add number to MS user event ​

Trigger on delete number from MS user event ​

Trigger on create MS resource account event ​

Trigger on update MS resource account event ​

Trigger on delete MS resource account event ​

Trigger on add number to resource account event ​

Trigger on delete number from resource account event ​

Trigger on onboarding step 1 - add domain event ​

Trigger on onboarding step 2 - create dummy user event ​

Trigger on onboarding step 3 - add DR data event ​

Notifications

Generic events

Trigger on `create distributor` event

Trigger on `update distributor` event

Trigger on `delete distributor` event

Trigger on `create reseller` event

Trigger on `update reseller` event

Trigger on `delete reseller` event

Trigger on `create tenant` event

Trigger on `update tenant` event

Trigger on `delete tenant` event

Trigger on `create subscription` event

Trigger on `update subscription` event

Trigger on `delete subscription` event

Trigger on `create a new order` event

Trigger on `delete an order` event

MS Teams specific events

Trigger on `create MS user` event

Trigger on `update MS user` event

Trigger on `delete MS user` event

Trigger on `add number to MS user` event

Trigger on `delete number from MS user` event

Trigger on `create MS resource account` event

Trigger on `update MS resource account` event

Trigger on `delete MS resource account` event

Trigger on `add number to resource account` event

Trigger on `delete number from resource account` event

Trigger on `onboarding step 1 - add domain` event

Trigger on `onboarding step 2 - create dummy user` event

Trigger on `onboarding step 3 - add DR data` event