---
title: "Read an entity hook request"
method: GET
path: "/entity_hook/{id}"
tags: ["Entity hook"]
---

# Read an entity hook request

`GET /entity_hook/{id}`

## Request

- Base URL: `https://api.nullplatform.com`
- URL: `https://api.nullplatform.com/entity_hook/{id}`
- Auth: HTTP bearer

Reads an entity hook request: one firing of an entity hook action for a specific entity.

The `id` is the one you receive in the hook notification (`notification.id`), and the URL matches its `callback_url`.

## Path parameters

- `id` string, uuid, required

## Response `200`

The entity hook request was found.

- EntityHookRequest
  - `id` string, uuid: The ID of the entity hook request.
  - `entity_hook_action_id` string, uuid: The entity hook action this request was fired from.
  - `entity_name` string: The type of entity the hook fired for.
  - `entity_id` string: The ID of the entity the hook fired for.
  - `entity_action` string: The action that fired the hook.
  - `nrn` string: The NRN of the entity the hook fired for.
  - `type` 'hook': The type of entity hook.
  - `when` 'before' | 'after': Whether the hook runs before or after nullplatform's internal logic.
  - `on` 'create' | 'update' | 'delete': The lifecycle event that triggered the hook.
  - `status` 'pending' | 'success' | 'failed' | 'recoverable_failure' | 'cancelled': The current status of the hook. It stays `pending` until you respond to it.
  - `messages` EntityHookMessage[]: Messages reported by the hook handler.
    - `level` 'info' | 'warning' | 'error', required: The severity of the message.
    - `message` string, required: A message shown to developers about the hook's execution.
    - `timestamp` integer: When the message was produced, as a Unix timestamp in milliseconds.
  - `callback_body` object, nullable: The fields the hook handler handed back to the entity, or `null` if it sent none.
  - `created_at` string, date-time: When the hook request was created.

## Other responses

- `4XX`: The request couldn't be processed. For example, a parameter is invalid, the resource doesn't exist, or you don't have permission. The body is a problem details object (RFC 9457).
- `5XX`: Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).

## Changes

- **2026-10-15** `728d4df70ca1`: 6 breaking, 15 info
  - the response property `message` became optional for the status `4XX`
  - the response property `message` became optional for the status `5XX`
  - removed the required property `error` from the response with the `4XX` status
  - removed the required property `error` from the response with the `5XX` status
  - …17 more
- **2026-09-09** `ca82c7ad96be`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nullplatform/apis/nullplatform-api/changes/entity_hook/:id/get.md)

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) - [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nullplatform/apis/nullplatform-api/revisions/d3f66bc633d4?raw)