---
title: "webhooks-api"
url: "https://earlyaccess.developers.bynder.com/apis/webhooks-api/versions/876c7972-129f-4814-b12a-964ddc49f2b6"
---

# webhooks-api

OpenAPI specification document.

```json
{"components":{"schemas":{"ActivateSubscriptionRequest":{"properties":{"config_id":{"type":"string"},"status":{"format":"int32","type":"integer"}},"required":["config_id","status"],"type":"object"},"ActivateSubscriptionResponse":{"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"required":["message","success"],"type":"object"},"ActorSystemObject":{"properties":{"whenTerminated":{"type":"object"}},"required":["whenTerminated"],"type":"object"},"CreateSubscriptionRecord":{"properties":{"configId":{"type":"string"},"endpoint":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"portalId":{"type":"string"},"protocol":{"type":"string"},"subscriptionArn":{"type":"string"},"topicArn":{"type":"string"}},"required":["configId","endpoint","events","name","portalId","protocol","subscriptionArn","topicArn"],"type":"object"},"CreateSubscriptionRequest":{"properties":{"endpoint":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"protocol":{"type":"string"}},"required":["endpoint","events","name","protocol"],"type":"object"},"CreateSubscriptionResponse":{"properties":{"message":{"type":"string"},"record":{"$ref":"#/components/schemas/CreateSubscriptionRecord"},"success":{"type":"boolean"}},"required":["message","success"],"type":"object"},"Function1RequestContextFutureRouteResult":{"type":"object"},"ListString":{"items":{"type":"string"},"type":"array"},"ListSubscriptionItem":{"properties":{"configId":{"type":"string"},"endpoint":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"protocol":{"type":"string"},"status":{"format":"int32","type":"integer"}},"required":["configId","endpoint","events","name","protocol","status"],"type":"object"},"ListSubscriptionsResponse":{"properties":{"configs":{"items":{"$ref":"#/components/schemas/ListSubscriptionItem"},"type":"array"},"message":{"type":"string"},"success":{"type":"boolean"}},"required":["configs","message","success"],"type":"object"},"RenameSubscriptionRequest":{"properties":{"config_id":{"type":"string"},"name":{"type":"string"}},"required":["config_id","name"],"type":"object"},"RenameSubscriptionResponse":{"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"required":["message","success"],"type":"object"},"SeqListSubscriptionItem":{"items":{"$ref":"#/components/schemas/ListSubscriptionItem"},"type":"array"},"SeqString":{"items":{"type":"string"},"type":"array"},"UpdateSubscriptionEventsRecord":{"properties":{"configId":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"portalId":{"type":"string"}},"required":["configId","events","portalId"],"type":"object"},"UpdateSubscriptionRequest":{"properties":{"config_id":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"}},"required":["config_id","events"],"type":"object"},"UpdateSubscriptionResponse":{"properties":{"message":{"type":"string"},"record":{"$ref":"#/components/schemas/UpdateSubscriptionEventsRecord"},"success":{"type":"boolean"}},"required":["message","success"],"type":"object"}}},"info":{"description":"","termsOfService":"","title":"webhooks-api","version":"1.0.0"},"openapi":"3.0.1","paths":{"/webhooks/api/subscriptions":{"post":{"description":"Creates subscription","operationId":"createSubscriptionRoute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionResponse"}}},"description":"Successfully created subscription"},"400":{"description":"Failed to create subscription"}},"summary":"Creates user subscription based on chosen settings"},"put":{"description":"Updates subscription","operationId":"updateSubscriptionRoute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionResponse"}}},"description":"Successfully updated subscription"},"400":{"description":"Failed to update subscription"}},"summary":"Updates user subscription based on chosen settings"}},"/webhooks/api/subscriptions/activate":{"put":{"description":"Activates/Deactivates subscription","operationId":"activateSubscriptionRoute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateSubscriptionResponse"}}},"description":"Successfully updated state of config id to activated/deactivated"},"400":{"description":"Failed to update state of config id to activated/deactivated"}},"summary":"Activates/Deactivates subscription based on config ID and to portal ID"}},"/webhooks/api/subscriptions/list":{"get":{"description":"Gets portal subscriptions","operationId":"listSubscriptionsRoute","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActorSystemObject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"}}},"description":"Successfully listed subscriptions"},"400":{"description":"Failed to list subscriptions"}},"summary":"Gets all portal subscriptions"}},"/webhooks/api/subscriptions/rename":{"put":{"description":"Renames subscription","operationId":"renameSubscriptionRoute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameSubscriptionResponse"}}},"description":"Successfully renamed subscription"},"400":{"description":"Failed to rename subscription"}},"summary":"Renames user subscription based on provided name"}},"/webhooks/api/subscriptions/{configId}":{"delete":{"description":"Deletes subscription","operationId":"deleteSubscriptionRoute","parameters":[{"description":"Config ID","in":"path","name":"configId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Successfully deleted subscription"},"400":{"description":"Failed to delete subscription"}},"summary":"Deletes subscription based on config id"}}},"security":[],"servers":[{"description":"Local Development","url":"http://0.0.0.0:8081"}]}
```