Preflight a webhook configuration

Test a webhook configuration before creation.

Body Params

The webhook configuration object to be stored.

object

WebhookAuthentication composes all of the different supported authentication types for webhook requests

array of int64s

ExpectedStatus is the HTTP status expected from the API invoked by this webhook.
If not present a status code between 200 and 299 is expected (inclusive).
Expected status is checked prior to the incoming transform executing.

expectedStatus
array of objects

Headers with static values to include in the requests made by this
webhook when invoked.
Can be overridden using a transform.

headers
object
string
required

Name of the webhook

object

NotificationWebhookConfig is the criteria used to select notifications for
sending

array of strings
required

Purpose of this webhook. What extensions or integrations is it achieving.
Valid purposes can be found using the purposes API.

purpose*
array of objects

References to this webhook by extensions or integrations. Readonly.
A Webhook cannot be deleted while it has any references.

references
object

Resources defined by this webhook.

object
string
required

Type of webhook. Options are 'realtime' and 'notification'

array of strings
required

URLs this webhook should use when invoked. Accessed in round-robin
manner. Often failing URLs will be dropped from rotation for 5 minutes.
At least one URL must be provided.

When a URL is configured with the protocol 'http://' the connection made
to the webhook will be insecure. Use the protocol 'https://' to establish
a secure connection. The IBM Security Verify truststores will be used.

urls*
Responses

Language
URL
Choose an example:
application/json