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

# Portal events

> Every guest portal platform event an internal agent can run on, from portal views and offer purchases to security deposits, check-in steps and reviews, with the filters each one offers.

Portal events start an internal agent when a contact does something in a [guest portal](https://docs.conduit.ai/portals/overview.md), or when something happens to a portal payment, request or deposit. They appear in the picker once your workspace uses Portals. See [Platform events](https://docs.conduit.ai/build-your-agent/agents/internal-agents/platform-events/overview.md) for how to add a trigger.

## Portal filters

Every portal event can be filtered by template. Some also offer offer, total or rating filters.

| Filter | What it does | Available on |
| - | - | - |
| **Templates (optional)** | Only run for these portal templates. Empty runs for every template. | Every portal event |
| **Offers (optional)** | Only run when any of these offers is involved. Empty runs for every offer. | Offer, checkout, payment, refund and request events |
| **Minimum total (optional)** | Only run when the total is at least this amount. Empty runs for every total. | Portal checkout started, Portal payment submitted, Portal offer purchased, Portal payment failed, Portal refund issued |
| **Rating** | **Any rating**, or a rating that's **Exactly**, **At most** or **At least** a value. | Portal review submitted |

## Browsing and delivery

| Event | Runs when | Filters |
| - | - | - |
| **Portal viewed** | A customer opens a portal. | Templates |
| **Portal offer viewed** | A customer views an offer in a portal. | Templates, Offers |
| **Portal delivery failed** | A customer portal can't be delivered. | Templates |
| **Portal session completed** | A portal session is completed. | Templates |
| **Portal session expired** | A portal session expires without completion. | Templates |

**Example task (Portal delivery failed):** "The portal link for this reservation couldn't be delivered. Check the contact's phone and email, try the other channel, and add a note if both fail."

## Cart, checkout and payments

See [Offers](https://docs.conduit.ai/portals/offers.md) and [Payments](https://docs.conduit.ai/portals/payments.md) for how these work in the portal.

| Event | Runs when | Filters |
| - | - | - |
| **Portal offer added to cart** | A customer adds a portal offer to cart. | Templates, Offers |
| **Portal offer removed from cart** | A customer removes a portal offer from cart. | Templates, Offers |
| **Portal checkout opened** | A customer opens checkout from a portal. | Templates, Offers |
| **Portal checkout started** | A portal purchase is created. | Templates, Offers, Minimum total |
| **Portal payment submitted** | A customer submits payment for a portal offer. | Templates, Offers, Minimum total |
| **Portal offer purchased** | A customer purchases a portal offer. | Templates, Offers, Minimum total |
| **Portal payment failed** | A portal payment fails. | Templates, Offers, Minimum total |
| **Portal refund issued** | A portal refund is issued. | Templates, Offers, Minimum total |
| **Portal fee paid** | A required check-in fee is paid on a portal. | Templates |

**Example task (Portal offer purchased, Offers: Early check-in):** "The guest bought early check-in. Find today's cleaning task for their unit, raise its priority to urgent, and tell the assigned cleaner the new deadline."

**Example task (Portal offer removed from cart):** "The guest removed an offer from their cart. Don't message them. Add a note to the conversation so the team knows which offer they were interested in."

## Requests

Request offers need your approval before the payment is captured. See [Requests](https://docs.conduit.ai/portals/requests.md).

| Event | Runs when | Filters |
| - | - | - |
| **Portal request submitted** | A contact submits a request offer for approval. | Templates, Offers |
| **Portal request approved** | A request is approved and the payment captured. | Templates, Offers |
| **Portal request declined** | A request is declined and the hold released. | Templates, Offers |
| **Portal request expired** | A request expires without a decision. | Templates, Offers |

**Example task (Portal request submitted, Offers: Late checkout):** "The guest requested late checkout. Check whether another reservation checks in to the same unit that day. Post your recommendation, approve or decline, with the reason, to #front-desk in Slack."

## Security deposits

| Event | Runs when | Filters |
| - | - | - |
| **Security deposit authorized** | A contact authorizes a security deposit hold. | Templates |
| **Security deposit captured** | An operator captures part or all of a deposit hold. | Templates |
| **Security deposit released** | A deposit hold is released back to the contact. | Templates |
| **Security deposit renewal required** | A deposit hold nears expiry and needs renewal. | Templates |

**Example task (Security deposit renewal required):** "This guest's deposit hold is about to expire. If they're still in-house, create a task for the front desk to collect a new hold today."

## Check-in steps

See [Check-in steps](https://docs.conduit.ai/portals/check-in-steps.md) for what each step collects.

| Event | Runs when | Filters |
| - | - | - |
| **Portal details submitted** | A contact submits their details during check-in. | Templates |
| **Portal questions answered** | A contact answers the check-in questions. | Templates |
| **Additional people added** | A contact adds other guests during check-in. | Templates |
| **Agreement signed** | A contact signs the agreement during check-in. | Templates |
| **Damage waiver completed** | A contact completes the damage waiver during check-in. | Templates |
| **Portal check-in completed** | A contact completes all required check-in steps. | Templates |

**Example task (Portal questions answered):** "The guest answered the check-in questions. If they mentioned an anniversary, honeymoon or birthday, create a task for the assigned cleaner to leave a small welcome touch."

## Reviews

See [Reviews](https://docs.conduit.ai/portals/reviews.md).

| Event | Runs when | Filters |
| - | - | - |
| **Portal review submitted** | A contact rates their stay after checkout. | Templates, Rating |

**Example task (Portal review submitted, Rating: At most 3):** "A guest left a low rating. Read their review and the stay's conversation, summarize what went wrong, and post it to #guest-experience in Slack with a suggested reply."


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