Update a Webhook

put https://{tenanturl}/config/v1.0/webhooks/{id}

Updates a webhook configuration.

Path Params

string

required

ID of the webhook to update

Body Params

The webhook configuration object to be stored.

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

Response body

object

authentication

object

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

basic

object

BasicAuthentication is the structure that backs a basic scheme provider

header

object

HeaderAuthentication contains a list of headers used to authenticate

jwt

object

mtls

object

oauth

object

OAuthAuthentication contains the oauth standard fields used to perform a client-credentials flow

type

string

required

Type selects the authentication method to use.
Valid values are: header, basic, oauth, mtls

expectedStatus

array of int64s

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

object

key

string

value

string

metadata

object

connector

string

Connector is used by the UX to modify presentation of the configuration

contactEmail

string

ContactEmail is the email address of an external entity to contact about this configuration

contactName

string

ContactName is the name of an external entity to contact about this configuration.

createdBy

string

CreatedBy is the userID who created the configuration
Readonly

createdByType

string

CreatedByType is the type of user who created the configuration
Readonly

dateCreated

date-time

DateCreated will indicate when this configuration was first created
Readonly.

dateModified

date-time

DateModified will indicate when this configuration was last modified
Readonly

modifiedBy

string

CreatedBy is the userID who last modified the configuration
Readonly

modifiedByType

string

ModifiedByType is the type of user who last modified the configuration
Readonly

properties

object

Properties are aribtrary non functional properties of this configuration.
Not used at runtime.

name

string

required

Name of the webhook

notification

object

NotificationWebhookConfig is the criteria used to select notifications for
sending

deadletters

object

NotificationDeadletters is the configuration pertaining to the deadletters
recorded by this webhook

enabled

boolean

required

Enabled is used to disable a notification webhook when not in use

interests

array of objects

required

Interests contains the selection critiera for notifications this webhooks
should be invoked with. If any one interests is satisfied for a given
event, it will be sent

For example to configure a webhook which gets both management and sso
events, the webhook would have two intrests. One in events where the type
is SSO, and one where the type is management

interests*

object

clauses

array of objects

required

All clauses must be satisfied to indicate interests.

Clauses is a set of matches which must evaluate to true for a given notification to be included.*

object

key

string

required

Key into the event data to match on.
Only top level and data keys are allowed.

operation

string

required

Operation indicates what sort of clause this is. Valid values are 'include' and 'exclude'. Required.

All include clauses must be satisfied to include a event

If any exclude clause is matched, the event will not be included

value

string

required

Value to match against.
Full text must match.

description

string

Description helps identify this interest

name

string

required

recordDeadletters

boolean

RecordDeadletters indicates whether or not failed delivery attempts
should be recorded for manual reconciliation.

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

object

created

date-time

When this reference was created

location

string

Location of the API holding this reference

metadata

object

metadata contains arbitrary data about this reference

name

string

Name of the entity holding this reference

resources

object

Resources defined by this webhook.

transform

object

incoming

string

IncomingTransform is CEL applied to the HTTP response from the invoked API.
It can be used to modify the:
Incoming HTTP headers
Incoming JSON/body

outgoing

string

OutgoingTransform is CEL applied to the HTTP request being made by this webhook invocation.
It can be used to modify the:
HTTP Method
Request URL
Content-type
Outgoing headers
Outgoing JSON/body
Skip applying configured authentication

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.

urls*

string

Unique identifier of the webhook

Language

URL


xxxxxxxxxx
11
1
curl --request PUT \
2
     --url https://tenant_url/config/v1.0/webhooks/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "notification": {
8
    "enabled": true
9
  }
10
}
11
'

Choose an example:

application/json

200The webhook configuration

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.