List Webhooks

• Request Parameters

• Response

Returns a list of all webhooks.

JavaScript

Returns a list of all webhooks.

Code

await seam.webhooks.list();

Output

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

cURL

Returns a list of all webhooks.

Code

curl --include --request POST "https://connect.getseam.com/webhooks/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

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

Python

Returns a list of all webhooks.

Code

seam.webhooks.list()

Output

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

Ruby

Returns a list of all webhooks.

Code

seam.webhooks.list()

Output

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

PHP

Returns a list of all webhooks.

Code

<?php
$seam->webhooks->list();

Output

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

Seam CLI

Returns a list of all webhooks.

Code

seam webhooks list

Output

[
  {
    "event_types": ["device.connected", "device.disconnected"],
    "secret": "mySecret",
    "url": "https://example.com/webhook",
    "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

None

Response

Array of webhooks

JSON

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