> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Outreach: Create Webhook
> Subscribe a URL to Outreach events, such as prospect or sequence changes. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.
Subscribe a URL to Outreach events, such as prospect or sequence changes.
> [!NOTE]
>
> Tool ID: `outreach_create_webhook`
## 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.
```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'outreach_create_webhook',
{
"data": {
"type": "webhook"
}
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_create_webhook --input '{
"data": {
"type": "webhook"
}
}' --json
```
## Example response
The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"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 describe outreach_create_webhook --json` for the latest machine-readable contract.
## Input reference
Create a New Webhook
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.data` | `object` | 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]. |
Show raw input schema
### Input JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Create a New Webhook",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "A configurable notification that submits external JSON-API-formatted HTTP requests whenever resources are modified.",
"properties": {
"action": {
"type": [
"string",
"null"
],
"description": "The action that will trigger this webhook (e.g. \"*\", \"created\", \"updated\", \"destroyed\"). Webhooks will only execute if both the action and resource match.",
"maxLength": 255
},
"active": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating whether the webhook is active."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the webhook was created.",
"format": "date-time"
},
"disabledReason": {
"type": [
"string",
"null"
],
"description": "The reason why webhook got temporarily disabled. Any update to a webhook resets this to a null value.",
"maxLength": 1024
},
"disabledSince": {
"type": [
"string",
"null"
],
"description": "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"
},
"disabledUntil": {
"type": [
"string",
"null"
],
"description": "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"
},
"payloadVersion": {
"type": [
"integer",
"null"
],
"description": "Format of the body data sent when the webhook makes a request. Valid values are 1 or 2."
},
"resource": {
"type": [
"string",
"null"
],
"description": "The resource that will trigger this webhook (e.g. \"*\", \"prospect\", \"sequenceState\"). Webhooks will only execute if both the action and resource match.",
"maxLength": 255
},
"secret": {
"type": [
"string",
"null"
],
"description": "A private token used to verify the authenticity of incoming webhook payloads.",
"maxLength": 255
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the webhook was last updated.",
"format": "date-time"
},
"url": {
"type": [
"string",
"null"
],
"description": "The URL where the webhook will route its POST HTTP request.",
"maxLength": 1024
}
},
"additionalProperties": false
},
"relationships": {
"type": "object",
"properties": {
"authorizer": {
"description": "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.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the webhook. You can use only the attribute id to filter webhooks by creator (e.g. filter[creator][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "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).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"webhook"
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
"include": {
"type": "string",
"description": "Comma-separated related resources to include."
},
"fields": {
"type": "object",
"description": "Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].",
"properties": {
"account": {
"type": "string"
},
"accountNote": {
"type": "string"
},
"auditLog": {
"type": "string"
},
"batch": {
"type": "string"
},
"batchItem": {
"type": "string"
},
"call": {
"type": "string"
},
"callDisposition": {
"type": "string"
},
"callPurpose": {
"type": "string"
},
"complianceRequest": {
"type": "string"
},
"contentCategory": {
"type": "string"
},
"contentCategoryMembership": {
"type": "string"
},
"contentCategoryOwnership": {
"type": "string"
},
"customDuty": {
"type": "string"
},
"duty": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"event": {
"type": "string"
},
"favorite": {
"type": "string"
},
"import": {
"type": "string"
},
"kaiaRecording": {
"type": "string"
},
"kaiaVoiceImport": {
"type": "string"
},
"mailAlias": {
"type": "string"
},
"mailbox": {
"type": "string"
},
"mailing": {
"type": "string"
},
"opportunity": {
"type": "string"
},
"opportunityProspectRole": {
"type": "string"
},
"opportunityStage": {
"type": "string"
},
"orgSetting": {
"type": "string"
},
"persona": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"product": {
"type": "string"
},
"profile": {
"type": "string"
},
"prospect": {
"type": "string"
},
"prospectNote": {
"type": "string"
},
"purchase": {
"type": "string"
},
"recipient": {
"type": "string"
},
"role": {
"type": "string"
},
"ruleset": {
"type": "string"
},
"sequence": {
"type": "string"
},
"sequenceState": {
"type": "string"
},
"sequenceStep": {
"type": "string"
},
"sequenceTemplate": {
"type": "string"
},
"snippet": {
"type": "string"
},
"stage": {
"type": "string"
},
"task": {
"type": "string"
},
"taskDisposition": {
"type": "string"
},
"taskPriority": {
"type": "string"
},
"taskPurpose": {
"type": "string"
},
"team": {
"type": "string"
},
"template": {
"type": "string"
},
"user": {
"type": "string"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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). |
Show raw output schema
### Output JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"description": "Provider response payload.",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "A configurable notification that submits external JSON-API-formatted HTTP requests whenever resources are modified.",
"properties": {
"action": {
"type": [
"string",
"null"
],
"description": "The action that will trigger this webhook (e.g. \"*\", \"created\", \"updated\", \"destroyed\"). Webhooks will only execute if both the action and resource match.",
"maxLength": 255
},
"active": {
"type": [
"boolean",
"null"
],
"description": "A boolean value indicating whether the webhook is active."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "The date and time the webhook was created.",
"format": "date-time"
},
"disabledReason": {
"type": [
"string",
"null"
],
"description": "The reason why webhook got temporarily disabled. Any update to a webhook resets this to a null value.",
"maxLength": 1024
},
"disabledSince": {
"type": [
"string",
"null"
],
"description": "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"
},
"disabledUntil": {
"type": [
"string",
"null"
],
"description": "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"
},
"payloadVersion": {
"type": [
"integer",
"null"
],
"description": "Format of the body data sent when the webhook makes a request. Valid values are 1 or 2."
},
"resource": {
"type": [
"string",
"null"
],
"description": "The resource that will trigger this webhook (e.g. \"*\", \"prospect\", \"sequenceState\"). Webhooks will only execute if both the action and resource match.",
"maxLength": 255
},
"secret": {
"type": [
"string",
"null"
],
"description": "A private token used to verify the authenticity of incoming webhook payloads.",
"maxLength": 255
},
"updatedAt": {
"type": [
"string",
"null"
],
"description": "The date and time the webhook was last updated.",
"format": "date-time"
},
"url": {
"type": [
"string",
"null"
],
"description": "The URL where the webhook will route its POST HTTP request.",
"maxLength": 1024
}
},
"additionalProperties": false
},
"id": {
"type": "integer"
},
"relationships": {
"type": "object",
"properties": {
"authorizer": {
"description": "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.",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"creator": {
"description": "The creator of the webhook. You can use only the attribute id to filter webhooks by creator (e.g. filter[creator][id]=X).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updater": {
"description": "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).",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user"
]
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.