Search
K
Webhooks

webhooks-api

1.0.0OAS 3.0
API Base URL
  • Server 1:http://0.0.0.0:8081

    Local Development

Creates user subscription based on chosen settings

Creates subscription

post
http://0.0.0.0:8081/webhooks/api/subscriptions

Body

application/json

CreateSubscriptionRequest

endpointstringrequired
eventsarray[string]required
namestringrequired
protocolstringrequired

Response

application/json

Successfully created subscription

CreateSubscriptionResponse

messagestringrequired
recordobject
Show Child Parameters
successbooleanrequired
post/webhooks/api/subscriptions

Body

{ "endpoint": "endpoint", "events": [], "name": "name", "protocol": "protocol" }
 
application/json

Updates user subscription based on chosen settings

Updates subscription

put
http://0.0.0.0:8081/webhooks/api/subscriptions

Body

application/json

UpdateSubscriptionRequest

config_idstringrequired
eventsarray[string]required

Response

application/json

Successfully updated subscription

UpdateSubscriptionResponse

messagestringrequired
recordobject
Show Child Parameters
successbooleanrequired
put/webhooks/api/subscriptions

Body

{ "config_id": "config_id", "events": [] }
 
application/json

Activates/Deactivates subscription based on config ID and to portal ID

Activates/Deactivates subscription

put
http://0.0.0.0:8081/webhooks/api/subscriptions/activate

Body

application/json

ActivateSubscriptionRequest

config_idstringrequired
statusinteger(int32)required

Response

application/json

Successfully updated state of config id to activated/deactivated

ActivateSubscriptionResponse

messagestringrequired
successbooleanrequired
put/webhooks/api/subscriptions/activate

Body

{ "config_id": "config_id", "status": 0 }
 
application/json