Config
Retrieves a list of webhook configurations for a given tenant.
Required scopes
webhook.subscription_read
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Returning list of webhook configs.
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
Some server-side error occurred. Details are provided in the response payload.
GET /webhook/{tenant}/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"code": "svix",
"provider": "SVIX_SHARED",
"active": true
}
]
Creates a new webhook config for a given tenant. Currently the service supports the following webhook providers:
Svix Emporix Shared Account
Svix Custom Account
HTTP Webhook Strategy
NOTE Svix supports a maximum message payload size of approximately 350kb. However, it is generally advisable to keep webhook payloads small, ideally under 40kb. For larger message sizes, consider using the HTTP Webhook Strategy.
Required scopes
webhook.subscription_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Unique identifier of webhook configuration
Result of creating config
Request was syntactically incorrect. Details are provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
Conflict. The resource already exists.
Some server-side error occurred. Details are provided in the response payload.
POST /webhook/{tenant}/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"code": "svix",
"active": true,
"provider": "SVIX_SHARED",
"configuration": {}
}
{
"code": "svix"
}
Retrieves a webhook configuration for a given tenant.
Required scopes
webhook.subscription_read
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Unique identifier of webhook config.
Returning a webhook config.
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
The requested resource does not exist.
Some server-side error occurred. Details are provided in the response payload.
GET /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"code": "svix",
"provider": "SVIX_SHARED",
"active": true
}
Updates a webhook config for a given tenant. Currently the service supports the following webhook providers:
Svix Emporix Shared Account
Svix Custom Account
Required scopes
webhook.subscription_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Unique identifier of webhook config.
No content
Request was syntactically incorrect. Details are provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
Conflict. The resource already exists.
Some server-side error occurred. Details are provided in the response payload.
PUT /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"active": true,
"provider": "SVIX_SHARED",
"configuration": {}
}
No content
Removes a webhook configuration for a given tenant.
Required scopes
webhook.subscription_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Unique identifier of webhook config.
This flag set to "true" allows to delete active config
false
No content
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
Some server-side error occurred. Details are provided in the response payload.
DELETE /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Partially updates a webhook config for a given tenant. Single update may contain multiple partial updates in the form of an array. Following operations are allowed:
REMOVE
- removing an item from the listUPSERT
- adding or updating given property
Required scopes
webhook.subscription_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Unique identifier of webhook config.
Kind of the update operation
Path for identyifing which properties should be updated
Svix Api Key
Active flag
Destination URL where event should be sent
Secret key needed to sign messages sent via HTTP requests.
No content
Request was syntactically incorrect. Details are provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match the scopes required by the endpoint.
Some server-side error occurred. Details are provided in the response payload.
PATCH /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131
[
{
"op": "UPSERT",
"path": "/active",
"value": true
},
{
"op": "UPSERT",
"path": "/configuration/svix/apiKey",
"value": "SARFJ353DSTGSd3w3cZXX"
}
]
No content
Was this helpful?