Event Portal - API Management

Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
Registrations
Gateways
Reference - Managed configuration on PS+ Brokers

Event Portal - API Management

Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
Registrations
Gateways
Reference - Managed configuration on PS+ Brokers

(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)

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

Coming Soon - Creates a new webhook registration on the App Registration

URL Expired

The URL for this request expired after 30 days.

Path Params

registrationId

string

required

length between 4 and 32

the id of an Application Registration

Body Params

new webhook

uri

string

required

length between 0 and 200

name

string

length between 0 and 128

gatewayMessagingServiceIds

array of strings

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

required

Defaults to POST

mode

string

Defaults to parallel

authentication

object

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.

Show Deprecated

Responses

Response body

object

data

object

required

uri

string

required

length between 0 and 200

name

string

length between 0 and 128

gatewayMessagingServiceIds

array of strings

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

required

Defaults to POST

POST PUT

mode

string

Defaults to parallel

parallel serial

authentication

object

tlsOptions

object

deprecated

TLS options required to support older PS+ brokers.

requestHeaders

array of objects

length between 0 and 50

requestHeaders

object

headerName

string

required

length between 1 and 50

headerValue

string

required

length between 1 and 1024

appendTopicToUrl

boolean

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

meta

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

data

object

required

uri

string

required

length between 0 and 200

name

string

length between 0 and 128

gatewayMessagingServiceIds

array of strings

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

required

Defaults to POST

POST PUT

mode

string

Defaults to parallel

parallel serial

authentication

object

tlsOptions

object

deprecated

TLS options required to support older PS+ brokers.

requestHeaders

array of objects

length between 0 and 50

requestHeaders

object

headerName

string

required

length between 1 and 50

headerValue

string

required

length between 1 and 1024

appendTopicToUrl

boolean

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

meta

object

Updated about 1 year ago

(Early Access) Returns a list of webhook registrations (Coming Soon)

(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://apim-production-api.solace.cloud/api/v2/apim/appRegistrations/registrationId/webhooks \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"method":"POST"}'

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

application/json

Updated about 1 year ago

(Early Access) Returns a list of webhook registrations (Coming Soon)

(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)

Did this page help you?

Event Portal - API Management
Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget
Reference - Managed configuration on PS+ Brokers

Event Portal - API Management
Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget
Reference - Managed configuration on PS+ Brokers

201new webhook

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.

defaultnew webhook