> ## 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: Get Sample Webhook Event Payload

> Get a sample EmailBison webhook payload for an event type. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get a sample EmailBison webhook payload for an event type.

> [!NOTE]
>
> Tool ID: `emailbison_get_sample_webhook_event_payload`

## 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_get_sample_webhook_event_payload',
  {
    "event_type": "email_sent"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_get_sample_webhook_event_payload --input '{
  "event_type": "email_sent"
}' --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": "example"
}
```

Use `deepline describe emailbison_get_sample_webhook_event_payload --json` for the latest machine-readable contract.

## Input reference

Get sample webhook event payload

| 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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get sample webhook event payload",
    "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"
        ]
      }
    },
    "required": [
      "event_type"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `string` | Yes | — | Provider response payload. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "string",
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.