PRproject44
Webhook

Create or update a push configuration.

Create or update a single push configuration. A maximum of 50 push configurations may be saved per tenant.

put/api/v4/webhooks

Request

Request body

authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authType'API_KEY' | 'BASIC' | 'OAUTH2' | 'MTLS' | 'AD_OAUTH2_CERT'

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

configNamestring

A unique name used to identify the push configuration.

idinteger

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

method'GET' | 'POST' | 'PUT' | 'PATCH'

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormat'JSON'

The format of the payload to send to the webhook. JSON is the only format supported.

urlstring

The URL of the webhook endpoint.

versioninteger

An optional version of the push configuration.

Response

OK

authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authType'API_KEY' | 'BASIC' | 'OAUTH2' | 'MTLS' | 'AD_OAUTH2_CERT'

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

configNamestring

A unique name used to identify the push configuration.

idinteger

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

method'GET' | 'POST' | 'PUT' | 'PATCH'

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormat'JSON'

The format of the payload to send to the webhook. JSON is the only format supported.

urlstring

The URL of the webhook endpoint.

versioninteger

An optional version of the push configuration.

Changes

No recorded changes to this operation across all 1 revision of this API.