Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

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

Body

application/json

The webhook to create

name
string
required

The name of the webhook

Example:

"My Webhook"

description
string | null
required

The description of the webhook

Example:

"This webhook is used to send data to the example.com/webhook"

targetUrl
string
required

The URL that the webhook will send the data to

Example:

"https://example.com/webhook"

secret
string
required

The secret that the webhook will use to authenticate the data

Example:

"secret123"

active
boolean
required

Whether the webhook is active

Example:

true

sensor
string | null

The sensor that the webhook is associated with

Example:

"sensor123"

Response

Webhook created successfully

webhook
object
required