Deel: List webhooks
Deel webhooks.getWebhooks: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation deel.webhooks_getwebhooks
Provider route: GET /webhooks. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["webhooks"]["getWebhooks"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.webhooks.getWebhooks(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.webhooks.get_webhooks(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum: 100 Minimum: 1 |
query.cursor | string | Optional | Maximum length: 150 |
query.status | string | Optional | One of: enabled, disabled |
query.hidden | boolean | Optional | |
query.search | string | Optional | Maximum length: 200 |
query._order | string | Optional | Pattern: ^(name|created_at|status)(:(asc|desc))?$ |
query.include | string | Optional | One of: stats |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List webhooks — 200 response body |
Referenced models: List webhooks — 200 response body
Schemas
Section titled “Schemas”List webhooks — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
cursor (anyOf 2) | null | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
data | array | Required within parent | The list of webhook subscriptions. |
data[] | Model | Each item | Expand List webhooks — 200 response body — data item |
Referenced models: List webhooks — 200 response body — data item
List webhooks — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_version | string | Required within parent | Deel API version. Currently Deel accepts v1 or v2. Default: v2 |
created_at | string | Required within parent | Time at which the webhook was created. |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Time at which the webhook was deleted. |
deleted_at (anyOf 2) | null | Alternative | Time at which the webhook was deleted. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Webhook subscription description. |
description (anyOf 2) | null | Alternative | Webhook subscription description. |
events | array | Required within parent | The list of events to enable for this subscription. |
events[] | string | Each item | |
hidden | JSON | Optional | |
hidden (anyOf 1) | boolean | Alternative | Whether to hide the webhook from the frontend view (commonly used by Deel third-party apps). |
hidden (anyOf 2) | null | Alternative | Whether to hide the webhook from the frontend view (commonly used by Deel third-party apps). |
id | string | Required within parent | Unique identifier of this resource. |
include_child_orgs | JSON | Optional | |
include_child_orgs (anyOf 1) | boolean | Alternative | When true, the webhook will also receive events from child organizations. |
include_child_orgs (anyOf 2) | null | Alternative | When true, the webhook will also receive events from child organizations. |
internal | boolean | Optional | Indicates whether the webhook is internal to Deel. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Webhook subscription name. |
name (anyOf 2) | null | Alternative | Webhook subscription name. |
signing_key | JSON | Required within parent | |
signing_key (anyOf 1) | string | Alternative | The webhook's signing key, used to generate webhook signatures. |
signing_key (anyOf 2) | null | Alternative | The webhook's signing key, used to generate webhook signatures. |
stats | Model | Optional | Expand List webhooks — 200 response body — data item stats Delivery health for the last 7 days. Present only when `include=stats` is sent. |
status | string | Required within parent | Status of webhook. Known values: enabled, disabled |
updated_at | string | Required within parent | Time at which the webhook was updated. |
url | string | Required within parent | Endpoint to receive webhook. |
Referenced models: List webhooks — 200 response body — data item stats
List webhooks — 200 response body — data item stats
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery health for the last 7 days. Present only when `include=stats` is sent. |
daily | array | Required within parent | Per UTC day totals, oldest first. |
daily[] | Model | Each item | Expand List webhooks — 200 response body — data item stats daily item |
failed | JSON | Required within parent | |
failed (anyOf 1) | integer | Alternative | Failed delivery attempts in the window. |
failed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
p95_latency_ms | JSON | Required within parent | |
p95_latency_ms (anyOf 1) | JSON | Alternative | |
p95_latency_ms (anyOf 1) (anyOf 1) | number | Alternative | 95th percentile delivery latency in milliseconds. Format: double |
p95_latency_ms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
p95_latency_ms (anyOf 2) | null | Alternative | 95th percentile delivery latency in milliseconds. Format: double |
succeeded | JSON | Required within parent | |
succeeded (anyOf 1) | integer | Alternative | Successful delivery attempts in the window. |
succeeded (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
success_rate | JSON | Required within parent | |
success_rate (anyOf 1) | JSON | Alternative | |
success_rate (anyOf 1) (anyOf 1) | number | Alternative | Success percentage (0-100, one decimal); null when nothing was delivered. Format: double |
success_rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
success_rate (anyOf 2) | null | Alternative | Success percentage (0-100, one decimal); null when nothing was delivered. Format: double |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Delivery attempts in the window. |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
window_days | JSON | Required within parent | |
window_days (anyOf 1) | integer | Alternative | Number of days covered. |
window_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List webhooks — 200 response body — data item stats daily item
List webhooks — 200 response body — data item stats daily item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | UTC day, `YYYY-MM-DD`. |
succeeded | JSON | Required within parent | |
succeeded (anyOf 1) | integer | Alternative | Successful delivery attempts on this day. |
succeeded (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Delivery attempts on this day. |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.webhooks_getwebhooks. Catalog operation: webhooks/list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["webhooks:read"]
Pinned headers: {"X-Version": "2026-01-01"}