Get a Webhook

• Request Parameters

• Response

Gets a specified webhook.

JavaScript

Gets a specified webhook.

Code

await seam.webhooks.get({ webhook_id: "e5f1b17c-c67d-469d-a860-9510cf814657" });

Output

{
  "event_types": ["device.connected", "device.disconnected"],
  "secret": "mySecret",
  "url": "https://example.com/webhook",
  "webhook_id": "e5f1b17c-c67d-469d-a860-9510cf814657"
}

cURL

Gets a specified webhook.

Code

curl --include --request POST "https://connect.getseam.com/webhooks/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "webhook_id": "e5f1b17c-c67d-469d-a860-9510cf814657"
}
EOF

Output

{
  "webhook": {
    "event_types": ["device.connected", "device.disconnected"],
    "secret": "mySecret",
    "url": "https://example.com/webhook",
    "webhook_id": "e5f1b17c-c67d-469d-a860-9510cf814657"
  }
}

Python

Gets a specified webhook.

Code

seam.webhooks.get(webhook_id="e5f1b17c-c67d-469d-a860-9510cf814657")

Output

Webhook(
    event_types=["device.connected", "device.disconnected"],
    secret="mySecret",
    url="https://example.com/webhook",
    webhook_id="e5f1b17c-c67d-469d-a860-9510cf814657",
)

Ruby

Gets a specified webhook.

Code

seam.webhooks.get(webhook_id: "e5f1b17c-c67d-469d-a860-9510cf814657")

Output

{
  "event_types" => %w[device.connected device.disconnected],
  "secret" => "mySecret",
  "url" => "https://example.com/webhook",
  "webhook_id" => "e5f1b17c-c67d-469d-a860-9510cf814657",
}

PHP

Gets a specified webhook.

Code

<?php
$seam->webhooks->get(webhook_id: "e5f1b17c-c67d-469d-a860-9510cf814657");

Output

<?php
[
    "event_types" => ["device.connected", "device.disconnected"],
    "secret" => "mySecret",
    "url" => "https://example.com/webhook",
    "webhook_id" => "e5f1b17c-c67d-469d-a860-9510cf814657",
];

Seam CLI

Gets a specified webhook.

Code

seam webhooks get --webhook_id "e5f1b17c-c67d-469d-a860-9510cf814657"

Output

{
  "event_types": ["device.connected", "device.disconnected"],
  "secret": "mySecret",
  "url": "https://example.com/webhook",
  "webhook_id": "e5f1b17c-c67d-469d-a860-9510cf814657"
}

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

webhook_id String (Required)

ID of the webhook that you want to get.

---

Response

webhook

JSON

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