Config
Was this helpful?
Was this helpful?
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.
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
}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
falseDELETE /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
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.
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
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"
}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.
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
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 list
UPSERT - 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.
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