Subscriptions

Update a Subscription

Updates an existing subscription. Follow conventional PATCH behavior, so only included fields will be updated.

PATCH
/v1-alpha/subscriptions/{subscriptionID}
x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

subscriptionIDstring

ID of the subscription to update

name?string

Name of subscription.

type?string

Type of subscription.

Value in"transform" | "analyze" | "route" | "join" | "split_collection" | "split_item" | "evaluation" | "error"
disabled?boolean

Toggles whether subscription is active or not.

functionName?string

Unique name of function this subscription listens to.

webhookURL?string

URL bem will send webhook requests to.

Response Body

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