(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)

patch

https://apim-production-api.solace.cloud/api/v2/apim/appRegistrations/{registrationId}/webhooks/{webhookId}

Coming Soon - Updates the specified webhook registration on the App Registration

Path Params

registrationId

string

required

length between 4 and 32

the id of an Application Registration

webhookId

string

required

length between 4 and 188

the id of a webhook

Body Params

uri

string

required

length between 0 and 200

name

string

length between 0 and 128

gatewayMessagingServiceIds

array of objects

length between 0 and 255

messaging services that this webhook service is available on, if absent webhook will be used for all associated messaging services

gatewayMessagingServiceIds

method

string

enum

required

Defaults to POST

Allowed:

mode

string

enum

Defaults to parallel

Allowed:

authentication

object

tlsOptions

object

deprecated

TLS options required to support older PS+ brokers.

requestHeaders

array of objects

length between 0 and 50

requestHeaders

appendTopicToUrl

boolean

Inidicates if the message topic should be appended to the webhook url when the request is made by the messaging service.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200webhook

400Bad request, contains information about failed back end calls when the app is provisioned

401Unauthorized.

403Forbidden.

404Not Found.

406Not Acceptable.

412PreConditon Failed, likely a mismatch between current etag and if-match header

415Unsupported Media Type.

422Duplicate app or invalid object reference e.g. invalid API product name

429Too many requests.

500Internal Server error, contains information about failed back end calls when the app is provisioned

503Service Unavailable.

504Gateway Timeout.

defaultwebhook