Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum: 100
Minimum: 1
query.cursorstringOptionalMaximum length: 150
query.statusstringOptionalOne of: enabled, disabled
query.hiddenbooleanOptional
query.searchstringOptionalMaximum length: 200
query._orderstringOptionalPattern: ^(name|created_at|status)(:(asc|desc))?$
query.includestringOptionalOne of: stats

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List webhooks — 200 response body

Referenced models: List webhooks — 200 response body

List webhooks — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
cursor (anyOf 2)nullAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
dataarrayRequired within parentThe list of webhook subscriptions.
data[]ModelEach itemExpand List webhooks — 200 response body — data item

Referenced models: List webhooks — 200 response body — data item

List webhooks — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
api_versionstringRequired within parentDeel API version. Currently Deel accepts v1 or v2.
Default: v2
created_atstringRequired within parentTime at which the webhook was created.
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime at which the webhook was deleted.
deleted_at (anyOf 2)nullAlternativeTime at which the webhook was deleted.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeWebhook subscription description.
description (anyOf 2)nullAlternativeWebhook subscription description.
eventsarrayRequired within parentThe list of events to enable for this subscription.
events[]stringEach item
hiddenJSONOptional
hidden (anyOf 1)booleanAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
hidden (anyOf 2)nullAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
idstringRequired within parentUnique identifier of this resource.
include_child_orgsJSONOptional
include_child_orgs (anyOf 1)booleanAlternativeWhen true, the webhook will also receive events from child organizations.
include_child_orgs (anyOf 2)nullAlternativeWhen true, the webhook will also receive events from child organizations.
internalbooleanOptionalIndicates whether the webhook is internal to Deel.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeWebhook subscription name.
name (anyOf 2)nullAlternativeWebhook subscription name.
signing_keyJSONRequired within parent
signing_key (anyOf 1)stringAlternativeThe webhook's signing key, used to generate webhook signatures.
signing_key (anyOf 2)nullAlternativeThe webhook's signing key, used to generate webhook signatures.
statsModelOptionalExpand List webhooks — 200 response body — data item stats
Delivery health for the last 7 days. Present only when `include=stats` is sent.
statusstringRequired within parentStatus of webhook.
Known values: enabled, disabled
updated_atstringRequired within parentTime at which the webhook was updated.
urlstringRequired within parentEndpoint to receive webhook.

Referenced models: List webhooks — 200 response body — data item stats

List webhooks — 200 response body — data item stats
FieldTypePresenceDescription and constraints
$objectRootDelivery health for the last 7 days. Present only when `include=stats` is sent.
dailyarrayRequired within parentPer UTC day totals, oldest first.
daily[]ModelEach itemExpand List webhooks — 200 response body — data item stats daily item
failedJSONRequired within parent
failed (anyOf 1)integerAlternativeFailed delivery attempts in the window.
failed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
p95_latency_msJSONRequired within parent
p95_latency_ms (anyOf 1)JSONAlternative
p95_latency_ms (anyOf 1) (anyOf 1)numberAlternative95th percentile delivery latency in milliseconds.
Format: double
p95_latency_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
p95_latency_ms (anyOf 2)nullAlternative95th percentile delivery latency in milliseconds.
Format: double
succeededJSONRequired within parent
succeeded (anyOf 1)integerAlternativeSuccessful delivery attempts in the window.
succeeded (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success_rateJSONRequired within parent
success_rate (anyOf 1)JSONAlternative
success_rate (anyOf 1) (anyOf 1)numberAlternativeSuccess percentage (0-100, one decimal); null when nothing was delivered.
Format: double
success_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success_rate (anyOf 2)nullAlternativeSuccess percentage (0-100, one decimal); null when nothing was delivered.
Format: double
totalJSONRequired within parent
total (anyOf 1)integerAlternativeDelivery attempts in the window.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
window_daysJSONRequired within parent
window_days (anyOf 1)integerAlternativeNumber of days covered.
window_days (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentUTC day, `YYYY-MM-DD`.
succeededJSONRequired within parent
succeeded (anyOf 1)integerAlternativeSuccessful delivery attempts on this day.
succeeded (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONRequired within parent
total (anyOf 1)integerAlternativeDelivery attempts on this day.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.