The webhooksubscription object representation and fields are described below.
webhooksubscription was introduced in API version V1
webhooksubscription has not been marked for deprecation
Representation of a webhook subscription to listen for events supported by the given subject
| Name | Type | Description | Constraints |
|---|---|---|---|
| urn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | ||
| apiClient | API Client | Required on create. Ignored on update. | |
| subject | A string representation of a enumeration name restricted to the documented values | The subject of the subscription. Note that subjects are fine grained to allow clients to subscribe only to the events which they require. | Required on create. Allowed values:
|
| event | A string representation of a enumeration name restricted to the documented values | The event trigger which the subscription would like to receive. | Required on create. Allowed values:
|
| destinationUrl | URL represented as a string | Required on create. Maximum length: 1024. | |
| auth | A string representation of a enumeration name restricted to the documented values | The authentication mechanism to use when delivering webhook events. | Allowed values:
|
| secret | A secret key string used for HMAC-SHA256 signing and in the case of BASIC and DIGEST authentication where it is used as the secret or the digest key. | Secret value used for header HMAC SHA256 signature generation. If BASIC authentication is used then this value will be passed as the secret with the username as the client ID of the API client. For DIGEST, it will be used to calculate the digest. BEARER authentication uses a bearer token associated with the API client with the scope = 'webhook.baack.co.' as well as sending the HMAC header and is the suggested approach as it also allows key rotation. Note, on read a SHA256 digest of the secret is returned (the value is never returned by the API). | Required on create. |
| expirationTimestamp | Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone. | Expiration time for the subscription or +90 days used if not set | |
| eventsPerMinute | Signed int32 | The requested maximum events per minute that Baack will send for this subscription. Note that multiple subscriptions will result in multiple event rate limits per minute being combined with each subscription having it's own rate limit. | Required on create. Minimum: 1. Maximum: 6000. |