> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conduit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform events

> Run an internal agent when something happens in Conduit, such as a new reservation, a task assignment or a portal payment, and narrow which events start it with filters.

A platform event trigger runs an internal agent when something happens in your Conduit workspace: a reservation is created, a task is assigned, a call is missed, a guest pays in a portal. These are the same events that start [workflows](https://docs.conduit.ai/workflows/getting-started.md), so you don't need to build a companion workflow. Pick the event, and the agent runs every time it fires.

Use a platform event when the right response depends on judgment. When a cleaning status changes, a workflow can send the same message every time. An agent can check whether a guest arrives today, whether they asked for early check-in, and whether a message would help at all.

Open the agent and select **Runs on > Workflow**. The sidebar row shows how many platform event triggers are active, or **Setup** when none are.

## Event categories

> [card] [Reservations and appointments](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/reservations-and-appointments.md)
>
> New and modified reservations and appointments, reservation labels, and runs timed to check-in or check-out.

> [card] [Contacts and conversations](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/contacts-and-conversations.md)
>
> New contacts, contact attributes and labels, conversation tags and escalations.

> [card] [Tasks](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/tasks.md)
>
> Tasks created, modified, started, assigned and completed.

> [card] [Operations, calls and widget](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/operations-calls-and-widget.md)
>
> Cleaning status changes, completed and missed calls, and widget forms and sessions.

> [card] [Portals](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/portals.md)
>
> Every guest portal event, from the first view to payments, deposits, check-in steps and reviews.

> [card] [Integrations](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/integrations.md)
>
> Workflow webhooks, Stripe and Jobber.

The picker only offers events your workspace can produce. For example, portal events appear once your workspace uses [Portals](https://docs.conduit.ai/portals/overview.md), and Stripe and Jobber events appear once those connections are set up.

## Add a trigger

**1. Pick an event**

Select **Add trigger**, then search for the event or pick it from its category.

**2. Narrow it down**

Under **Filters**, choose which events should start the agent, such as only reservations in one inbox. Every filter is optional. For **Check-in** and **Check-out**, set the **Timing** instead. Each event page lists its filters.

**3. Write the task**

Under **Task**, tell the agent what to do with this event. Conduit sends the task to the agent with the event payload each time the trigger fires. The task is optional.

**4. Save**

Select **Add trigger**.

You can add each event once per agent. **Check-in** and **Check-out** are the exception: add them as many times as you need, each with its own timing.

## How filters work

Filters use the same options as the workflow builder for that event. Leaving every filter empty runs the agent on every event of that type. Events without filters say so in the sheet: the agent runs on every event of that type.

Many events can be filtered by **Inbox**. An empty inbox means any inbox. For most events, once you set a filter that depends on the inbox, such as a tag or a status, you also need to pick the inbox. The sheet shows "Select an inbox to use these filters" until you do.

Select **Clear** to remove every filter from a trigger.

## Write a good task

The agent gets the event payload and your task, then uses its tools to look up anything else. A good task says:

* **What the event means for this agent.** "A reservation was just cancelled."
* **What to check.** "Look for open cleaning tasks for that stay."
* **What to do.** "Cancel them and post a note to #housekeeping in Slack."
* **When to do nothing.** "If check-in was more than 30 days away, do nothing."

## Test a trigger

Select **Mock event** while editing a trigger to run the agent once with an empty mock payload. To test with a realistic payload, use **Run now > Workflow** instead, pick the event type, and paste the payload as JSON. See [Run now with a mocked trigger](https://docs.conduit.ai/build-your-agent/agents/internal-agents/chat-and-activity.md#run-now-with-a-mocked-trigger).

**Check-in** and **Check-out** triggers can't be mocked, because Conduit fires them per reservation.

## Manage triggers

Each trigger in the list shows its event, its filters, and whether it's **Active** or **Inactive**.

* Use the switch to turn a trigger on or off.
* Select edit to change its filters, timing or task.
* Select delete to remove it. Deleting a trigger can't be undone.

## All platform events

| Category | Events |
| - | - |
| [Reservations and appointments](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/reservations-and-appointments.md) | New reservation, Reservation modified, Reservation label added, Check-in, Check-out, New appointment, Appointment modified |
| [Contacts and conversations](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/contacts-and-conversations.md) | New contact, Contact attribute updated, Contact label added, Conversation tag added, Escalation created |
| [Tasks](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/tasks.md) | New task, Task modified, Task started, Task assigned, Task completed |
| [Operations, calls and widget](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/operations-calls-and-widget.md) | Cleaning status changed, Call completed, Call missed, Widget form submitted, Widget session ended |
| [Portals](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/portals.md) | Portal viewed, Portal offer viewed, Portal offer added to cart, Portal offer removed from cart, Portal checkout opened, Portal checkout started, Portal payment submitted, Portal offer purchased, Portal payment failed, Portal refund issued, Portal delivery failed, Portal session completed, Portal session expired, Portal check-in completed, Portal request submitted, Portal request approved, Portal request declined, Portal request expired, Portal fee paid, Security deposit authorized, Security deposit captured, Security deposit released, Security deposit renewal required, Agreement signed, Damage waiver completed, Portal details submitted, Portal questions answered, Additional people added, Portal review submitted |
| [Integrations](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/integrations.md) | Workflow webhook received, Stripe webhook, Jobber job created, Jobber job updated, Jobber job closed, Jobber visit completed |

> [!NOTE]
>
> In the agent sidebar, platform events live under **Runs on > Workflow**, because they're the same events that power workflows.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.