Create subscription

1min
POST
https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions
Create the subscription for the app
User will need to specify the topic Name, appId of the app which published this events and events that he wants to subscribe.
customAttr: (default: false) If the user wants custom attributes to be sent as part of webhook payload, then he will need to set this flag.
Note1: Subscriber will only be created with customAttr=true only if subscribing app has access to the publisher app.
Note2: Max 5 subscribers are allowed per unique Event
Header Parameters
X-COREOS-APP-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-AUTH
string
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
CreateSubscriptionRequest
*
description
string
topic
string<participant-egress | entity-egress | container-egress | order-egress | dispatch-egressv2>
*
eventsAppName
string
events
string[]
isActive
boolean
customAttr
boolean
webhook
object
*
Responses
201
OK - The request succeeded.
SuccessSubscriptionWriteResponse
data
SuccessIdResponseDTO
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "topic": "",
  "webhook": {
    "url": "",
    "signatureKey": ""
  }
}'
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "topic": "",
  "webhook": {
    "url": "",
    "signatureKey": ""
  }
}'
Responses
201
400
401
403
404
503
// OK - The request succeeded. 
{
  "data": {
    "id": ""
  }
}
// OK - The request succeeded. 
{
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 07 Feb 2024
Did this page help you?
Update event details
Get subscriptions