Preflight a webhook configuration

post

https://{tenanturl}/config/v1.0/webhooks/pretest/{resource}

Test a webhook configuration before creation using a specific resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

resource

string

required

Name of the resource of this configuration to use for pretest

Body Params

The webhook configuration object to be stored.

WebhookConfig contains all of the fields needed to perform a call out to an external rest API

authentication

object

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

expectedStatus

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

headers

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

metadata

object

name

string

required

Name of the webhook

notification

object

NotificationWebhookConfig is the criteria used to select notifications for
sending

purpose

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*

references

array of objects

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

references

resources

object

Resources defined by this webhook.

transform

object

type

string

required

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

urls

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

Loading…

Response

Choose an example:

application/json

200Webhook Test object

400The request cannot be processed because the request body contains improperly structured JSON.

401The unauthenticated user does not have the permissions to perform the requested operation.

403The unauthenticated user does not have the permissions to perform the requested operation.

404The resource cannot be found.

500Internal Server Error.