> ## 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.
# EmailBison: Send Atest Webhook Event
> Send a test EmailBison webhook event of a chosen type to a URL. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Send a test EmailBison webhook event of a chosen type to a URL.
> [!NOTE]
>
> Tool ID: `emailbison_send_atest_webhook_event`
## 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(
'emailbison_send_atest_webhook_event',
{
"event_type": "email_sent",
"url": "https://example.com"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_send_atest_webhook_event --input '{
"event_type": "email_sent",
"url": "https://example.com"
}' --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": {
"success": true,
"message": "Example message",
"payload": {
"event": {
"type": "example",
"name": "Example",
"workspace_id": 123
},
"data": {
"scheduled_email": {},
"campaign_event": {},
"lead": {}
}
}
}
}
}
```
Use `deepline describe emailbison_send_atest_webhook_event --json` for the latest machine-readable contract.
## Input reference
Send a test webhook for a chosen event type
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.event_type` | `"email_sent" \| "lead_first_contacted" \| "lead_replied" \| "lead_interested" \| "email_opened" \| "email_bounced" \| "lead_unsubscribed" \| "email_account_added" \| "email_account_removed" \| "email_account_disconnected" \| "email_account_reconnected" \| "manual_email_sent" \| "untracked_reply_received"` | Yes | — | The event type. Allowed: `email_sent`, `lead_first_contacted`, `lead_replied`, `lead_interested`, `email_opened`, `email_bounced`, `lead_unsubscribed`, `email_account_added`, `email_account_removed`, `email_account_disconnected`, `email_account_reconnected`, `manual_email_sent`, `untracked_reply_received`. |
| `payload.url` | `string` | Yes | — | The URL to send the webhook to. This must be an active URL that can receive requests. |
Show raw input schema
### Input JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Send a test webhook for a chosen event type",
"properties": {
"event_type": {
"type": "string",
"description": "The event type.",
"enum": [
"email_sent",
"lead_first_contacted",
"lead_replied",
"lead_interested",
"email_opened",
"email_bounced",
"lead_unsubscribed",
"email_account_added",
"email_account_removed",
"email_account_disconnected",
"email_account_reconnected",
"manual_email_sent",
"untracked_reply_received"
]
},
"url": {
"type": "string",
"description": "The URL to send the webhook to. This must be an active URL that can receive requests."
}
},
"required": [
"event_type",
"url"
],
"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.success` | `boolean` | No | — | — |
| `result.data.data.message` | `string` | No | — | — |
| `result.data.data.payload` | `object` | No | — | — |
| `result.data.data.payload.event` | `object` | No | — | — |
| `result.data.data.payload.event.type` | `string` | No | — | — |
| `result.data.data.payload.event.name` | `string` | No | — | — |
| `result.data.data.payload.event.workspace_id` | `integer` | No | — | — |
| `result.data.data.payload.event.workspace_name` | `string` | No | — | — |
| `result.data.data.payload.data` | `object` | No | — | — |
| `result.data.data.payload.data.scheduled_email` | `object` | No | — | — |
| `result.data.data.payload.data.scheduled_email.id` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.lead_id` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.sequence_step_id` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.email_subject` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.email_body` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.status` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.scheduled_date_est` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.scheduled_date_local` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.local_timezone` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.sent_at` | `string` | No | — | — |
| `result.data.data.payload.data.scheduled_email.opens` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.replies` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.unique_opens` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.unique_replies` | `integer` | No | — | — |
| `result.data.data.payload.data.scheduled_email.interested` | `string` | No | — | — |
| `result.data.data.payload.data.campaign_event` | `object` | No | — | — |
| `result.data.data.payload.data.campaign_event.id` | `integer` | No | — | — |
| `result.data.data.payload.data.campaign_event.type` | `string` | No | — | — |
| `result.data.data.payload.data.campaign_event.created_at_local` | `string` | No | — | — |
| `result.data.data.payload.data.campaign_event.local_timezone` | `string` | No | — | — |
| `result.data.data.payload.data.campaign_event.created_at` | `string` | No | — | — |
| `result.data.data.payload.data.lead` | `object` | No | — | — |
| `result.data.data.payload.data.lead.id` | `integer` | No | — | — |
| `result.data.data.payload.data.lead.uuid` | `string` | No | — | — |
| `result.data.data.payload.data.lead.email` | `string` | No | — | — |
| `result.data.data.payload.data.lead.first_name` | `string` | No | — | — |
| `result.data.data.payload.data.lead.last_name` | `string` | No | — | — |
| `result.data.data.payload.data.lead.status` | `string` | No | — | — |
| `result.data.data.payload.data.lead.title` | `string` | No | — | — |
| `result.data.data.payload.data.lead.company` | `string` | No | — | — |
| `result.data.data.payload.data.lead.custom_variables` | `array` | No | — | — |
| `result.data.data.payload.data.lead.custom_variables[].name` | `string` | No | — | — |
| `result.data.data.payload.data.lead.custom_variables[].value` | `string` | No | — | — |
| `result.data.data.payload.data.lead.emails_sent` | `integer` | No | — | — |
| `result.data.data.payload.data.lead.opens` | `integer` | No | — | — |
| `result.data.data.payload.data.lead.unique_opens` | `integer` | No | — | — |
| `result.data.data.payload.data.lead.replies` | `integer` | No | — | — |
| `result.data.data.payload.data.lead.unique_replies` | `integer` | No | — | — |
The table shows the first 50 fields. Expand the raw schema below for every field.
Show raw output schema
### Output JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"payload": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"workspace_id": {
"type": "integer"
},
"workspace_name": {
"type": "string"
}
},
"additionalProperties": false
},
"data": {
"type": "object",
"properties": {
"scheduled_email": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"lead_id": {
"type": "integer"
},
"sequence_step_id": {
"type": "integer"
},
"email_subject": {
"type": "string"
},
"email_body": {
"type": "string"
},
"status": {
"type": "string"
},
"scheduled_date_est": {
"type": "string"
},
"scheduled_date_local": {
"type": "string"
},
"local_timezone": {
"type": "string"
},
"sent_at": {
"type": "string"
},
"opens": {
"type": "integer"
},
"replies": {
"type": "integer"
},
"unique_opens": {
"type": "integer"
},
"unique_replies": {
"type": "integer"
},
"interested": {
"type": "string"
}
},
"additionalProperties": false
},
"campaign_event": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
},
"created_at_local": {
"type": "string"
},
"local_timezone": {
"type": "string"
},
"created_at": {
"type": "string"
}
},
"additionalProperties": false
},
"lead": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"uuid": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"company": {
"type": "string"
},
"custom_variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"emails_sent": {
"type": "integer"
},
"opens": {
"type": "integer"
},
"unique_opens": {
"type": "integer"
},
"replies": {
"type": "integer"
},
"unique_replies": {
"type": "integer"
},
"bounces": {
"type": "integer"
}
},
"additionalProperties": false
},
"campaign": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"sender_email": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"daily_limit": {
"type": "integer"
},
"emails_sent": {
"type": "integer"
},
"replied": {
"type": "integer"
},
"opened": {
"type": "integer"
},
"unsubscribed": {
"type": "integer"
},
"bounced": {
"type": "integer"
},
"unique_replies": {
"type": "integer"
},
"unique_opens": {
"type": "integer"
},
"total_leads_contacted": {
"type": "integer"
},
"interested": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"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
* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/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.