Subscriptions

Create a Subscription

Creates a new subscription to listen to transform or error events.

POST
/v1-alpha/subscriptions
x-api-key<token>

Authenticate using API Key in request header

In: header

namestring

Name of subscription.

typestring

Type of subscription.

Value in"transform" | "analyze" | "route" | "join" | "split_collection" | "split_item" | "evaluation" | "error"
functionName?string

Unique name of function this subscription listens to.

disabled?boolean

Toggles whether subscription is active or not.

webhookURL?string

URL bem will send webhook requests to.

Response Body

curl -X POST "https://api.bem.ai/v1-alpha/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "transform"  }'
{
  "name": "string",
  "subscriptionID": "string",
  "type": "transform",
  "functionID": "string",
  "functionName": "string",
  "disabled": true,
  "webhookURL": "https://bem-example.ai/test/url"
}