CommunitySupport PortalYouTubeStart a free trial

Config

Retrieving a list of webhook configs

get

Retrieves a list of webhook configurations for a given tenant.

Required scopes

  • webhook.subscription_read

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

Responses
200
Returning list of webhook configs.
application/json
get
GET /webhook/{tenant}/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "code": "svix",
    "provider": "SVIX_SHARED",
    "active": true
  }
]

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 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

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

Body
codeall ofRequired
stringOptional

Unique identifier of webhook configuration

Responses
201
Result of creating config
application/json
post
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"
}

Retrieving a webhook config

get

Retrieves a webhook configuration for a given tenant.

Required scopes

  • webhook.subscription_read

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

codestringRequired

Unique identifier of webhook config.

Responses
200
Returning a webhook config.
application/json
get
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
}

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

  • webhook.subscription_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

codestringRequired

Unique identifier of webhook config.

Body
configurationone ofOptional
objectOptional
or
or
Responses
204
No content
put
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

Removing a webhook config

delete

Removes a webhook configuration for a given tenant.

Required scopes

  • webhook.subscription_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

codestringRequired

Unique identifier of webhook config.

Query parameters
forcebooleanOptional

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

Default: false
Responses
204
No content
delete
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

  • webhook.subscription_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

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

codestringRequired

Unique identifier of webhook config.

Bodyobject[]
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
patch
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
PreviousAPI ReferenceNextEvents

Was this helpful?