Skip to main content
POST
/
webhooks
/
create
await seam.webhooks.create({
  url: "https://example.com",
  event_types: ["device.connected", "device.disconnected"],
});

/*
{
  "event_types": [
    "device.connected",
    "device.disconnected"
  ],
  "secret": "mySecret",
  "url": "https://example.com",
  "webhook_id": "ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1"
}
*/
{
  "ok": true,
  "webhook": {
    "url": "<string>",
    "webhook_id": "<string>",
    "event_types": [
      "<string>"
    ],
    "secret": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string<uri>
required

URL for the new webhook.

​
event_types
string[]

Types of events that you want the new webhook to receive.

Response

OK

​
ok
boolean
required
​
webhook
object
required

Represents a webhook that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.