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

# The Inline Webhook object

> An inline webhook is an endpoint you host that Lumos calls partway through its own work. This page covers its types and where webhook IDs appear in the API.

An inline webhook is an endpoint you host that Lumos calls partway through its own work, such as
while it validates an access request. What Lumos does with what your endpoint returns depends on
the webhook's `type`.

v1 reads inline webhooks but doesn't create or change them. Configure them in the Lumos UI. The API
gives you their IDs, which other objects reference.

```json The Inline Webhook object theme={null}
{
  "id": "5e6f7081-9203-1234-ef12-345678901234",
  "type": "request-validation",
  "name": "Check cost center",
  "description": "Rejects requests from users with no cost center on file."
}
```

## Attributes

| Field | Type | Description |
| - | - | - |
| `id` | string | Unique identifier for the webhook. Always present. |
| `type` | string | The kind of step that calls the webhook: `pre-approval`, `provisioning`, `deprovisioning`, `request-validation`, or `siem`. Always present. |
| `name` | string | The webhook's name. Always present. |
| `description` | string or null | The webhook's description. |

The object carries no endpoint URL or credentials, only enough to identify the webhook. Listing
webhooks is open to every Lumos user.

## Types

[List Inline Webhooks](https://docs.lumos.com/api-reference/v1/inline-webhooks/list-inline-webhooks.md) returns every webhook
in your organization, of all five types:

* **`request-validation`**. Lumos calls it while it validates an access request, and it can reject
  the request. An app's AppStore settings name one in `request_validation_webhook_uuid`, as
  [Get AppStore Settings](https://docs.lumos.com/api-reference/v1/apps/get-appstore-settings.md) returns them, and so do an
  entitlement's, as [AppStore settings](https://docs.lumos.com/reference/v1/objects/entitlement.md#appstore-settings)
  describes.
* **`provisioning`** and **`deprovisioning`**. A [workflow's](https://docs.lumos.com/reference/v1/objects/workflow.md)
  `provisioning_webhook` and `deprovisioning_webhook` steps call these webhooks.
* **`pre-approval`**. Lumos calls it when it evaluates a pre-approval rule that uses it. Return
  `response: true` to satisfy that condition.
* **`siem`**. Receives each Lumos activity-log event when it's your organization's SIEM destination.

## Endpoints

| Endpoint | Path |
| - | - |
| [List Inline Webhooks](https://docs.lumos.com/api-reference/v1/inline-webhooks/list-inline-webhooks.md) | `GET /v1/inline-webhooks` |