Svix Emporix Shared Account

Retrieving a dashboard access URL

get

Retrieves a Svix magic login link (authentication embedded) and an authentication token needed to connect a tenant to their consumer application portal.

Required scopes

• webhook.subscription_manage

Required scopes

This endpoint requires the following scopes:

• : Needed to manage subscriptions.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Responses

200Success

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Some server-side error occurred. Details are provided in the response payload.

application/json

get

/webhook/{tenant}/dashboard-access

HTTPcURLJavaScriptPython

GET /webhook/{tenant}/dashboard-access HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "url": "https://app.svix.com/login#key=eyJhcHBJZCI6ICJhcHBfMXRSdFl",
  "token": "appsk_kV3ts5tKPNJN4Dl25cMTfUNdmabxbX0O"
}

Retrieving webhooks statistics

get

Retrieves statistics on the number of emitted events and provides information on the limit of webhook notifications configured for a specific tenant.

Required scopes

• webhook.subscription_read

Required scopes

This endpoint requires the following scopes:

• : Needed to read subscriptions.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters

fromYearMonthstringOptional

Month from which statistics should be retrieved.

Note: The value should be provided in the "YYYY-MM" format.

toYearMonthstringOptional

Month to which statistics should be retrieved.

Note: The value should be provided in the "YYYY-MM" format.

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.

application/json

500

Some server-side error occurred. Details are provided in the response payload.

application/json

get

/webhook/{tenant}/statistics

HTTPcURLJavaScriptPython

GET /webhook/{tenant}/statistics HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "monthStatistics": [
    {
      "statisticsMonth": "2022-09",
      "succesfullySentWebhooks": 8994
    },
    {
      "statisticsMonth": "2022-08",
      "succesfullySentWebhooks": 2137
    }
  ],
  "webhooksLimit": 10000
}