List webhook configurations

The page number of resources to return.

200

Response body

object

data

object

Defines the settings available and required to subscribe to one or more Convictional webhook topics. Please read more on webhooks here

active

boolean

Determines whether the webhook configuration is active and new events are POSTED to the target URL

created

date-time

Date that the configuration was created. A RFC 3339 formatted date string.

health

string

Describes whether the conifiguration is considered healthy.
a configuration is unhealthy if the target URL responds with
a non HTTP 200 status code for an extended period of time (3 days) and events cannot be delivered.

healthy failed

string

The globally unique, internal Convictional object identifier for this item.

lastRun

date-time

The last time an event was sent to this target URL. A RFC 3339 formatted date string.

limiterBurst

integer

Defaults to 0

The highest burst rate of requests used by the limiter to determine delivery speed of new topics to the target URL.
Must be smaller than or equal to the limiterRate defined above.
Must be a positive integer. Default value is 0 which means NO LIMIT

limiterRate

integer

Defaults to 0

The limiter rate used to thorttle topic delivery to the target URL.
Must be a positive integer. Default value is 0 which means NO LIMIT

secrets

array of objects

A list of secrets used to create Convictional-Signature headers to verify webhook data integrety.
You are able to attach more than one secret to a webhook configuration and both validation tokens will be sent.
This is to assit with token renewals so that your webhook can migrate from one token to the other without any
downtime.

secrets

object

created

date-time

Date that the validation secret was created. A RFC 3339 formatted date string.

expiresDate

date-time

Date that the secret expires. A RFC 3339 formatted date string.

string

The globally unique, internal Convictional object identifier for this item.

secret

string

The secret used to verify the integrity of the data sent by webhooks.
This can only be set at create time. If you need to edit or change a secret you must set the expiry date
of the one you want to edit in the near future and create a new one with the correct Secret. The system
will attach both to your request so you will still be able to validate against the correct one.
This is to prevent secrets from changing unexpectedly and breaking the validation step.

targetUrl

string

The full URL to which new webhook events are POSTed

topics

array of strings

List of topics that the URL specified by this configuration should receive

topics

updated

date-time

Date that the configuration was last updated. A RFC 3339 formatted date string.

error

array of objects

error

object

message

string

hasMore

boolean

string

200OK

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error