Config

Retrieving a list of webhook configs

get

Retrieves a list of webhook configurations for a given tenant. A tenant can have at most one configuration per type: svix, svix_shared, and http.

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.

Responses

200

Returning list of webhook configs.

application/json

activebooleanOptional

Indicates whether a given configuration is active. Only one configuration can be active at a time.

providerstring · enumOptional

Indicates which provider should be used.

Possible values:

codestringOptional

Unique identifier of the webhook configuration type.

configurationone ofOptional

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}/config

HTTPcURLJavaScriptPython

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

[
  {
    "code": "svix_shared",
    "provider": "SVIX_SHARED",
    "active": true
  },
  {
    "code": "svix",
    "provider": "SVIX",
    "active": false
  },
  {
    "code": "http",
    "provider": "HTTP",
    "active": false
  }
]

Creating a single webhook config

post

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 At any time, a tenant can have only one webhook configuration of each type: svix, svix_shared, and http. If a configuration of the requested type already exists, the request returns a 409 Conflict response. To change the configuration, update or delete the existing one.

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

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.

Body

application/json

activebooleanOptional

Indicates whether a given configuration is active. Only one configuration can be active at a time.

providerstring · enumRequired

Indicates which provider should be used.

Possible values:

configurationone ofOptional

object · EmptyConfigurationOptional

SVIX_SHARED config

or

or

codestringRequired

Unique identifier of the webhook configuration type.

Responses

201

Result of creating config

application/json

codestringOptional

400

Request was syntactically incorrect. Details are provided in the response payload.

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

409

Conflict. The resource already exists, for example when creating a webhook configuration for a type that is already configured.

application/json

500

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

application/json

post/webhook/{tenant}/config

HTTPcURLJavaScriptPython

POST /webhook/{tenant}/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "code": "svix_shared",
  "active": true,
  "provider": "SVIX_SHARED",
  "configuration": {}
}

SVIX_SHAREDSVIXHTTP

{
  "code": "svix"
}

Retrieving a webhook config

get

Retrieves a webhook configuration for a given tenant.

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.

codestringRequired

Unique identifier of the webhook configuration type.

Responses

200

Returning a webhook config.

application/json

activebooleanOptional

Indicates whether a given configuration is active. Only one configuration can be active at a time.

providerstring · enumOptional

Indicates which provider should be used.

Possible values:

codestringOptional

Unique identifier of the webhook configuration type.

configurationone ofOptional

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}/config/{code}

HTTPcURLJavaScriptPython

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

{
  "code": "svix_shared",
  "provider": "SVIX_SHARED",
  "active": true
}

Updating a single webhook config

put

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

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.

codestringRequired

Unique identifier of the webhook configuration type.

Body

application/json

activebooleanOptional

Indicates whether a given configuration is active. Only one configuration can be active at a time.

providerstring · enumRequired

Indicates which provider should be used.

Possible values:

configurationone ofOptional

object · EmptyConfigurationOptional

SVIX_SHARED config

or

or

Responses

204

No content

No content

400

Request was syntactically incorrect. Details are provided in the response payload.

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

409

Conflict. The resource already exists, for example when creating a webhook configuration for a type that is already configured.

application/json

500

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

application/json

put/webhook/{tenant}/config/{code}

HTTPcURLJavaScriptPython

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

SVIX_SHAREDSVIXHTTP

No content

Removing a webhook config

delete

Removes a webhook configuration for a given tenant.

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.

codestringRequired

Unique identifier of the webhook configuration type.

Query parameters

forcebooleanOptional

This flag set to "true" allows to delete active config

Default: false

Responses

204

No content

No content

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

delete/webhook/{tenant}/config/{code}

HTTPcURLJavaScriptPython

DELETE /webhook/{tenant}/config/{code} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating a webhook config

patch

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

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.

codestringRequired

Unique identifier of the webhook configuration type.

Bodyobject · WebhookConfigPartialUpdate[]

application/json

opstring · enumRequired

Kind of the update operation

Possible values:

pathstring · enumRequired

Path for identyifing which properties should be updated

Possible values:

valueany ofOptional

or

or

stringOptional

Svix Api Key

or

booleanOptional

Active flag

or

stringOptional

Destination URL where event should be sent

or

stringOptional

Secret key needed to sign messages sent via HTTP requests.

or

or

Responses

204

No content

No content

400

Request was syntactically incorrect. Details are provided in the response payload.

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

patch/webhook/{tenant}/config/{code}

HTTPcURLJavaScriptPython

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

Multiple Update ListActiveConfiguration SvixConfiguration Svix Api KeyConfiguration Http HeadersConfiguration Http Destination UrlConfiguration Http Secret KeyConfiguration HttpUpsert Configuration Event TypesRemove Configuration Event TypesUpsert Configuration Event TypeRemove Configuration Event TypeUpsert Configuration Event Type Destination UrlUpsert Configuration Event Type Secret KeyUpsert Configuration Event Type Headers

No content