Skip to main content
POST
/
webhook-filters
Create a webhook filter
curl --request POST \
  --url https://caliper.alpha-1edtech.ai/webhook-filters/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookId": "123e4567-e89b-12d3-a456-426614174000",
  "filterKey": "sensor",
  "filterValue": "sensor123",
  "filterType": "string",
  "filterOperation": "eq",
  "active": true
}
'
{
  "filter": {
    "webhookId": "123e4567-e89b-12d3-a456-426614174000",
    "filterKey": "sensor",
    "filterValue": "sensor123",
    "filterType": "string",
    "filterOperation": "eq",
    "active": true,
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "deletedAt": "2021-01-01T00:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

The webhook filter to create

​
webhookId
string
required

The unique identifier for the webhook, in UUID format

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
filterKey
string
required

The key to filter on

Example:

"sensor"

​
filterValue
string
required

The value to filter on

Example:

"sensor123"

​
filterType
enum<string>
required

The type of the filter value

Available options:
string,
number,
boolean
Example:

"string"

​
filterOperation
enum<string>
required

The operation to perform on the filter value

Available options:
eq,
neq,
gt,
gte,
lt,
lte,
contains,
notContains,
in,
notIn,
startsWith,
endsWith,
regexp
Example:

"eq"

​
active
boolean
required

Whether the filter is active

Example:

true

Response

Webhook filter created successfully

​
filter
object
required