# Cardly

Cardly helps businesses create great engagement with customers by getting out of inboxes and into mailboxes.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `CARDLY`
- **Version:** 20260217_00

## Tools

### Create Contact List

**Slug:** `CARDLY_CREATE_CONTACT_LIST`

Tool to add a new contact list. Use after defining name and optional custom fields, before populating the list with contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A short, unique name for this contact list. |
| `fields` | array | No | Custom fields to add to this list. New fields will be created; existing fields (matched by name) updated. |
| `description` | string | No | Free-text description of this contact list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Invitation

**Slug:** `CARDLY_CREATE_INVITATION`

Tool to send an invitation to use your organisation portal. Use when you need to grant access to a new user by their email address. If the email already has access, the API will return an appropriate error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | An email address for the user to invite. Required. |
| `lastName` | string | No | The last name of the user being invited. |
| `firstName` | string | No | The first name of the user being invited. |
| `permissions` | array | No | Zero or more permission identifiers denoting the privileges to grant the user once they accept your invitation. If omitted, the user will have default permissions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `CARDLY_CREATE_WEBHOOK`

Tool to create a new webhook subscription. Use when you need Cardly to notify your application via HTTP POST for specific events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | Yes | List of event names this webhook subscribes to; only notifications for these events will be sent. |
| `metadata` | object | No | Arbitrary key/value pairs to attach to this webhook for user-defined metadata. |
| `targetUrl` | string | Yes | The URL this webhook will send POST requests to once one of the subscribed events is triggered. Must be a valid HTTPS endpoint. |
| `description` | string | No | Free-text description of what this webhook is for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Invitation

**Slug:** `CARDLY_DELETE_INVITATION`

Tool to delete an invitation by unique ID, immediately invalidating it for acceptance. Use when you need to revoke a pending invitation using its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the invitation to revoke. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Invitation by Email

**Slug:** `CARDLY_DELETE_INVITATION_BY_EMAIL`

Deletes a pending invitation by email address, immediately invalidating it and preventing acceptance. This action is idempotent - deleting a non-existent invitation returns success. Use when you need to revoke access before an invitation is accepted, such as when correcting mistakes or revoking access for security reasons. Note: In test mode, the API returns an empty data object instead of the deleted invitation details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The exact email address of the invitation to delete. Must match the email used when the invitation was created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `CARDLY_DELETE_USER`

Tool to delete a user by unique ID, immediately revoking their access to your organisation portal. Use when removing user access is required. Cannot remove users with administrator privileges - attempting to delete an admin will fail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the user to delete. This immediately revokes their access to your organisation portal. Cannot remove users with administrator privileges. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User by Email

**Slug:** `CARDLY_DELETE_USER_BY_EMAIL`

Deletes a user by email address, immediately revoking their access to your organisation portal. This action cannot remove users with administrator privileges. Use when you need to revoke user access, such as when employees leave or access needs to be terminated. The API returns a 404 if no matching user is found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the user to delete. This will immediately revoke their access to your organisation portal. Cannot remove users with administrator privileges. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `CARDLY_DELETE_WEBHOOK`

Tool to delete a webhook. Use after confirming the webhook ID to immediately cease all activity and event subscriptions for that webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the webhook to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Echo Request

**Slug:** `CARDLY_ECHO_REQUEST`

Tool to echo all request parameters, body, and headers for debugging purposes. Use when validating authentication or testing API connectivity without affecting account data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bar` | array | No | A body parameter which will be returned to you in the response. |
| `foo` | string | No | A body parameter which will be returned to you in the response. |
| `test` | string | No | An example query parameter which will be returned to you in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Preview

**Slug:** `CARDLY_GENERATE_PREVIEW`

Tool to generate a low-quality, watermarked preview document for a card. Use after confirming artwork and template details to estimate costs and delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `style` | object | No | Global style overrides (optional) |
| `sender` | object | No | Sender details (provide all fields if specifying) |
| `artwork` | string | Yes | Artwork UUID to preview (obtain from LIST_ARTWORK action) |
| `messages` | object | No | Message overrides when not using a template |
| `shipToMe` | boolean | No | True to send a blank envelope back to sender |
| `template` | string | No | Template ID for variable substitution (optional) |
| `recipient` | object | Yes | Envelope recipient details |
| `variables` | object | No | Key/value map of template variables to inject |
| `shippingMethod` | string ("standard" | "tracked" | "express") | No | Shipping method (per-region support varies) |
| `requestedArrival` | string | No | Desired arrival date (ISO 8601) for estimates |
| `purchaseOrderNumber` | string | No | Reference number for internal tracking |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Artwork

**Slug:** `CARDLY_GET_ARTWORK`

Tool to retrieve information on a specific piece of artwork by its unique ID. Use when you need to fetch detailed artwork data including preview images, media specifications, and metadata. The ID can be obtained from the List Artwork action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the artwork you wish to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `CARDLY_GET_WEBHOOK`

Tool to get details on an existing webhook. Use this to retrieve information about a webhook's configuration, including its target URL, subscribed events, status, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the webhook to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Artwork

**Slug:** `CARDLY_LIST_ARTWORK`

Tool to retrieve the currently available artwork for your organisation. Use when you need to list and paginate artwork items, optionally filtering to only your own artwork.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of artwork items to return |
| `offset` | integer | No | Number of records to skip before returning results |
| `ownOnly` | boolean | No | If true, return only artwork owned by your organisation; defaults to false |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Lists

**Slug:** `CARDLY_LIST_CONTACT_LISTS`

Tool to retrieve all active contact lists for your organization. Use when you need to list and paginate contact lists with their custom fields and automation rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of contact lists to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of records to skip before returning results. Defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Credit History

**Slug:** `CARDLY_LIST_CREDIT_HISTORY`

Retrieves the account's credit transaction history showing all credits and debits. Returns a paginated list of balance changes with timestamps, amounts, and descriptions. Use to audit spending, review signup bonuses, track refunds, or investigate balance changes. Filter by date range using effectiveTime parameters. Supports standard pagination with limit and offset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to retrieve per page, must be at least 1. |
| `offset` | integer | No | Number of records to skip before starting to collect the result set, must be non-negative. |
| `effectiveTime.gt` | string | No | Filter transactions after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00'). |
| `effectiveTime.lt` | string | No | Filter transactions before this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00'). |
| `effectiveTime.gte` | string | No | Filter transactions at or after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00'). |
| `effectiveTime.lte` | string | No | Filter transactions before or at this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-31 23:59:59'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Doodles

**Slug:** `CARDLY_LIST_DOODLES`

Retrieve your currently available doodles from Cardly. Returns doodle metadata including name and restriction status. Use this to discover available doodle designs before creating cards.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organisationOnly` | boolean | No | If true, return only doodles that are exclusive to your organisation. Set to false (default) to see all available doodles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fonts

**Slug:** `CARDLY_LIST_FONTS`

List available fonts for handwriting and text personalization in Cardly cards. Returns font metadata including name, category, variants, and whether the font supports humanisation. Use this to discover font options before creating cards or generating previews.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of font records to return per page. Defaults to 25. Use lower values for faster responses or higher values to reduce pagination. |
| `offset` | integer | No | Number of font records to skip for pagination. Use 0 for the first page, then increment by limit for subsequent pages. |
| `organisationOnly` | boolean | No | Filter to show only organization-exclusive custom fonts. Set to false (default) to see all available fonts including public ones. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Gift Credit History

**Slug:** `CARDLY_LIST_GIFT_CREDIT_HISTORY`

Lists gift credit history records for your organization with pagination and optional time-based filtering. Gift credits are promotional credits that can be applied to orders. This action retrieves a history of gift credit additions, deductions, and balance changes. Returns empty results if no gift credit history exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return per page. Must be at least 1. Defaults to 25 if not specified. |
| `offset` | integer | No | Number of records to skip before returning results (for pagination). Must be non-negative. Defaults to 0 if not specified. |
| `effectiveTime.gt` | string | No | Filter for records after this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-01-01 00:00:00'). |
| `effectiveTime.lt` | string | No | Filter for records before this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-12-31 23:59:59'). |
| `effectiveTime.gte` | string | No | Filter for records at or after this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-01-01 00:00:00'). |
| `effectiveTime.lte` | string | No | Filter for records before or at this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-12-31 23:59:59'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invitations

**Slug:** `CARDLY_LIST_INVITATIONS`

Tool to retrieve active invitations for your organisation with optional filters. Use when you need to audit invited users and their statuses before sending new invitations or revoking access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of invitations to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of invitation records to skip before returning results. Defaults to 0 if omitted. |
| `expiredOnly` | boolean | No | If true, only return expired invitations. |
| `acceptedOnly` | boolean | No | If true, only return accepted invitations. |
| `includeAccepted` | boolean | No | If true, includes accepted invitations in the response. Default filters them out. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Media

**Slug:** `CARDLY_LIST_MEDIA`

Tool to retrieve the currently available media sizes for product artwork. Use when you need to explore or validate media options before creating artwork.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of media items to return, defaults to 25 if omitted. |
| `offset` | integer | No | Number of records to skip for pagination, defaults to 0 if omitted. |
| `organisationOnly` | boolean | No | If true, only return media items exclusive to your organisation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `CARDLY_LIST_ORDERS`

Retrieves a paginated list of orders placed by your organization. Returns detailed order information including customer details, costs, items, shipping info, and delivery tracking. Use optional limit and offset parameters to control pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of orders to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of records to skip before returning results. Defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `CARDLY_LIST_TEMPLATES`

Tool to retrieve your currently available templates from Cardly. Use to list and paginate templates for selection in card sends.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of templates to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of records to skip before returning results. Defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `CARDLY_LIST_USERS`

Tool to retrieve all users associated with your account. Use when you need to list and paginate user accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of users to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of user records to skip before returning results. Defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `CARDLY_LIST_WEBHOOKS`

Retrieves all webhooks configured for your organization, including their status, target URLs, subscribed events, and delivery statistics. Use this to audit existing webhooks, monitor their health, or get webhook IDs for updates/deletions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of webhooks to return. Defaults to API default if omitted. |
| `offset` | integer | No | Number of webhook records to skip before returning results. Defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Writing Styles

**Slug:** `CARDLY_LIST_WRITING_STYLES`

Tool to list available writing styles. Use when you need to retrieve writing styles available for handwriting personalization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of records to return, defaults to 25 if omitted. |
| `offset` | integer | No | Number of records to skip for pagination, defaults to 0 if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Account Balance

**Slug:** `CARDLY_RETRIEVE_ACCOUNT_BALANCE`

Tool to retrieve the current account and gift credit balances for your organisation. Use after authenticating to verify available credit before placing orders.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Order

**Slug:** `CARDLY_RETRIEVE_ORDER`

Retrieves detailed information about a specific order by its ID. Returns complete order data including customer details, items, costs, delivery information, and tracking details. Use this after obtaining an order ID from the List Orders action or from a known order reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique UUID of the order to retrieve. Obtain this from the List Orders action or from order creation responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve User

**Slug:** `CARDLY_RETRIEVE_USER`

Retrieves detailed information about a specific user account by ID. Returns user profile data including name, email, status, and permissions. Use list_users to get available user IDs first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique UUID identifier of the user to retrieve. Obtain this from the list_users action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `CARDLY_UPDATE_WEBHOOK`

Tool to update a webhook’s settings, including target URL and events. Use after retrieving existing webhook to apply configuration changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the webhook to update. |
| `events` | array | Yes | List of event names this webhook subscribes to; only notifications for these events will be sent. |
| `disabled` | boolean | No | If true, disables the webhook; if false, enables it. |
| `metadata` | object | No | Arbitrary key/value pairs to attach to this webhook for user-defined metadata. |
| `targetUrl` | string | Yes | The URL this webhook will send POST requests to once one of its subscribed events is triggered. |
| `description` | string | No | Free-text description of what this webhook is for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |