Create a Webhook

• Request Parameters

• Response

Creates a new webhook.

JavaScript

Creates a new webhook.

Code

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

Output

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

cURL

Creates a new webhook.

Code

curl --include --request POST "https://connect.getseam.com/webhooks/create" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "url": "https://example.com",
  "event_types": [
    "device.connected",
    "device.disconnected"
  ]
}
EOF

Output

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

Python

Creates a new webhook.

Code

seam.webhooks.create(
    url="https://example.com", event_types=["device.connected", "device.disconnected"]
)

Output

Webhook(
    event_types=["device.connected", "device.disconnected"],
    secret="mySecret",
    url="https://example.com",
    webhook_id="ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1",
)

Ruby

Creates a new webhook.

Code

seam.webhooks.create(
  url: "https://example.com",
  event_types: %w[device.connected device.disconnected],
)

Output

{
  "event_types" => %w[device.connected device.disconnected],
  "secret" => "mySecret",
  "url" => "https://example.com",
  "webhook_id" => "ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1",
}

PHP

Creates a new webhook.

Code

<?php
$seam->webhooks->create(
    url: "https://example.com",
    event_types: ["device.connected", "device.disconnected"]
);

Output

<?php
[
    "event_types" => ["device.connected", "device.disconnected"],
    "secret" => "mySecret",
    "url" => "https://example.com",
    "webhook_id" => "ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1",
];

Seam CLI

Creates a new webhook.

Code

seam webhooks create --url "https://example.com" --event_types ["device.connected","device.disconnected"]

Output

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

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

url String (Required)

URL for the new webhook.

---

event_types Array of Strings

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

---

Response

webhook

JSON

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