Unipile: List Webhooks

List the webhooks configured on the customer’s Unipile workspace.

Tool ID: unipile_list_webhooks

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_list_webhooks',
  {
    "cursor": "cursor_123",
    "limit": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_list_webhooks --input '{
  "cursor": "cursor_123",
  "limit": 123
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe unipile_list_webhooks --json for the complete live contract.

Input reference

Returns a list of the webhooks.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1.
`payload.limit`	`integer`	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250. Minimum: 1. Maximum: 250.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	@todo
`result.data.object`	`"WebhookList"`	Yes	—	Allowed: `WebhookList`.
`result.data.items`	`array`	Yes	—	—
`result.data.items[].object`	`"Webhook"`	Yes	—	—
`result.data.items[].id`	`string`	Yes	—	A unique identifier.
`result.data.items[].account_ids`	`array`	Yes	—	—
`result.data.items[].account_ids[].id`	`string`	Yes	—	A unique identifier.
`result.data.items[].account_ids[].name`	`string`	No	—	—
`result.data.items[].account_ids[].type`	`"GOOGLE" \| "GOOGLE_CALENDAR" \| "ICLOUD" \| "LINKEDIN" \| "MAIL" \| "MOBILE" \| "OUTLOOK" \| "TWITTER" \| "WHATSAPP" \| "SLACK" \| "TELEGRAM"`	Yes	—	—
`result.data.items[].enabled`	`boolean`	Yes	—	—
`result.data.items[].name`	`string`	No	—	—
`result.data.items[].request_url`	`string`	Yes	—	—
`result.data.items[].format`	`"json" \| "form"`	Yes	—	The format of data you recieve from the webhook. Accepted values: json \| form
`result.data.items[].headers`	`array`	Yes	—	—
`result.data.items[].headers[].key`	`string`	Yes	—	—
`result.data.items[].headers[].value`	`string`	Yes	—	—
`result.data.items[].data`	`array`	Yes	—	—
`result.data.items[].events`	`array`	No	—	—
`result.data.items[].type`	`"AUTO"`	Yes	—	—
`result.data.items[].trigger`	`object`	Yes	—	—
`result.data.items[].trigger.icon`	`"WebhookIcon" \| "SettingsInputIcon" \| "LeakAddIcon" \| "Diversity2Icon" \| "AutoFixHighIcon" \| "SignPostIcon" \| "ShutterSpeedIcon" \| "SyncAltIcon" \| "WhatsAppIcon" \| "LinkedInIcon" \| "ImportExportIcon" \| "PodcastsIcon" \| "CableIcon" \| "CalendarIcon"`	Yes	—	—
`result.data.items[].trigger.name`	`string`	Yes	—	—
`result.data.items[].trigger.context`	`"MESSAGE" \| "CHAT"`	Yes	—	—
`result.data.cursor`	`unknown \| null`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

This output schema is too large for an inline display. Read the complete live contract with deepline describe unipile_list_webhooks --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation