Skip to content
Docs
Select language:English

/api/v1/locations/{id}/webhooks (POST)

POST
/api/v1/locations/{id}/webhooks
curl --request POST \
  --url https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/webhooks \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "thing.created" ] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
url
required
string
>= 1 characters <= 500 characters
events
required
Array<string>
>= 1 items <= 8 items
Allowed values: thing.created thing.updated thing.moved thing.trashed thing.restored thing.lifecycle_changed reading.logged reminder.due

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
webhook
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
url
required
string
events
required
Array<string>
Allowed values: thing.created thing.updated thing.moved thing.trashed thing.restored thing.lifecycle_changed reading.logged reminder.due
active
required
boolean
failingSince
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
disabledReason
required
Any of:
string
Allowed values: creator_lost_role failing admin
createdBy
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
displayName
required
string
lastDelivery
object
status
required
string
Allowed values: pending delivered failed gave_up
at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
httpStatus
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
secret
required
string
Example
{
  "webhook": {
    "events": [
      "thing.created"
    ],
    "disabledReason": "creator_lost_role",
    "lastDelivery": {
      "status": "pending"
    }
  }
}