The details of the webhook subscription to be created.
Fields
Name | Description |
---|---|
String! | The type of event to subscribe to.See Event implementations for a list of supported values. |
String! | The scheme ID of the event.Currently, only seekAnz and seekAnzPublicTest are supported. |
String! | The algorithm for signing webhooks.Currently, two codes are defined:
== operator are susceptible to timing attacks. |
String! | The subscriber-owned URL where events will be sent to. |
String | The optional hirer ID to receive events from.By default webhook subscriptions will send events from all hirers the partner has access to.
Providing a hirer ID will filter events to the specified hirer. |
Int | The maximum number of events that will be sent in each HTTP request.This number must be between 1 and 10 inclusive. Defaults to 10. |
String | The secret for signing webhooks.This must be specified if signingAlgorithmCode is not None .
It is used as the key to generate a message authentication code for each request.The secret should be a random string with high entropy that is not reused for any other purpose.This field has a minimum length of 16 characters and a maximum length of 255 bytes in UTF-8 encoding. |
Seen in
Parent name | Parent type | Description |
---|---|---|
Input Object | webhookSubscription field |