Outreach: Get Webhook

Read an Outreach webhook by ID.

Tool ID: outreach_get_webhook

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_get_webhook',
  {
    "id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_get_webhook --input '{
  "id": 123
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "data": {
      "attributes": {
        "action": "example",
        "active": false,
        "createdAt": "2026-01-15T12:00:00Z"
      },
      "id": 123,
      "relationships": {
        "authorizer": {
          "data": {},
          "links": {}
        },
        "creator": {
          "data": {},
          "links": {}
        },
        "updater": {
          "data": {},
          "links": {}
        }
      }
    }
  }
}

Use deepline tools get outreach_get_webhook --json for the latest machine-readable contract.

Input reference

Get a Webhook by ID

Name	Type	Required	Default	Details
`payload.id`	`integer`	Yes	—	—
`payload.include`	`string`	No	—	Comma-separated related resources to include.
`payload.fields`	`object`	No	—	Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	—
`result.data.data.attributes`	`object`	No	—	A configurable notification that submits external JSON-API-formatted HTTP requests whenever resources are modified.
`result.data.data.attributes.action`	`string \| null`	No	—	The action that will trigger this webhook (e.g. ”*”, “created”, “updated”, “destroyed”). Webhooks will only execute if both the action and resource match. Maximum length: 255.
`result.data.data.attributes.active`	`boolean \| null`	No	—	A boolean value indicating whether the webhook is active.
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date and time the webhook was created. Format: `date-time`.
`result.data.data.attributes.disabledReason`	`string \| null`	No	—	The reason why webhook got temporarily disabled. Any update to a webhook resets this to a null value. Maximum length: 1024.
`result.data.data.attributes.disabledSince`	`string \| null`	No	—	The date and time when the webhook got temporarily disabled for the first time. Any update to a webhook resets this to a null value. Format: `date-time`.
`result.data.data.attributes.disabledUntil`	`string \| null`	No	—	The date and time till when the webhook got temporarily disabled. Any update to a webhook resets this to a null value. Format: `date-time`.
`result.data.data.attributes.payloadVersion`	`integer \| null`	No	—	Format of the body data sent when the webhook makes a request. Valid values are 1 or 2.
`result.data.data.attributes.resource`	`string \| null`	No	—	The resource that will trigger this webhook (e.g. ”*”, “prospect”, “sequenceState”). Webhooks will only execute if both the action and resource match. Maximum length: 255.
`result.data.data.attributes.secret`	`string \| null`	No	—	A private token used to verify the authenticity of incoming webhook payloads. Maximum length: 255.
`result.data.data.attributes.updatedAt`	`string \| null`	No	—	The date and time the webhook was last updated. Format: `date-time`.
`result.data.data.attributes.url`	`string \| null`	No	—	The URL where the webhook will route its POST HTTP request. Maximum length: 1024.
`result.data.data.id`	`integer`	No	—	—
`result.data.data.relationships`	`object`	No	—	—
`result.data.data.relationships.authorizer`	`object`	No	—	The authorizer of the webhook. The webhook will not deliver results if the authorizer does not have permission to read the resource being returned. Relationship authorizer cannot be used as a filter.
`result.data.data.relationships.authorizer.data`	`object \| null`	No	—	—
`result.data.data.relationships.authorizer.data.id`	`integer`	No	—	—
`result.data.data.relationships.authorizer.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.authorizer.links`	`object`	No	—	—
`result.data.data.relationships.authorizer.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.creator`	`object`	No	—	The creator of the webhook. You can use only the attribute id to filter webhooks by creator (e.g. filter[creator][id]=X).
`result.data.data.relationships.creator.data`	`object \| null`	No	—	—
`result.data.data.relationships.creator.data.id`	`integer`	No	—	—
`result.data.data.relationships.creator.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.creator.links`	`object`	No	—	—
`result.data.data.relationships.creator.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.relationships.updater`	`object`	No	—	The most recent updater of the webhook. You can use only the attribute id to filter webhooks by updater (e.g. filter[updater][id]=X).
`result.data.data.relationships.updater.data`	`object \| null`	No	—	—
`result.data.data.relationships.updater.data.id`	`integer`	No	—	—
`result.data.data.relationships.updater.data.type`	`"user"`	No	—	Allowed: `user`.
`result.data.data.relationships.updater.links`	`object`	No	—	—
`result.data.data.relationships.updater.links.related`	`string`	No	—	Format: `uri`.
`result.data.data.type`	`string`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Outreach: Get Webhook

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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