Retrieve your Consumer App Portal link

Use the Indirect Tax API to retrieve the Consumer App Portal link after configuring the webhook communication method to use the Svix solution to receive notifications.

Configure the webhook communication method through the API or through the Compliance Network website.

Send a GET request to /v2/configurations/organizations/{organizationId}/erpSystem/{erpSystemId}/webhook.
Include the following headers in your request:
- Content-Type: application/json
- Authorization: Bearer {accessToken}
- x-correlationId: {uniqueValue}

Include the following path parameters inside the JSON payload in the request body.


Name		Type	Required	Description
organizationId		string	Yes	The organization ID obtained from the Sovos Professional Services team
erpSystemId		string	Yes	The unique identifier of the ERP system (SystemId).

Upon successful configuration, the API returns your Consumer App Portal link, which you need to configure to receive notifications, as explained in the Svix documentation.

Samples for retrieving the consumer app portal link

Request sample

JSON

curl --location --request GET 'https://api-test.sovos.com/v2/configurations/organizations/{organizationId}/erpSystem/{erpSystemId}/webhook' \
--header Content-Type: application/json \
--header Authorization: Bearer {accessToken} \
--header x-correlationId: {uniqueValue}

curl --location --request GET 'https://api-test.sovos.com/v2/configurations/organizations/{organizationId}/erpSystem/{erpSystemId}/webhook' \
--header Content-Type: application/json \
--header Authorization: Bearer {accessToken} \
--header x-correlationId: {uniqueValue}

Response sample