NUnullplatform
Entity hook

Read an entity hook request

Changed on

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.

get/entity_hook/{id}

Request

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

Path parameters

idstring uuid required

The ID of the entity hook request.

Response

The entity hook request was found.

idstring uuid

The ID of the entity hook request.

entity_hook_action_idstring uuid

The entity hook action this request was fired from.

entity_namestring

The type of entity the hook fired for.

entity_idstring

The ID of the entity the hook fired for.

entity_actionstring

The action that fired the hook.

nrnstring

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.

callback_bodyobject nullable

The fields the hook handler handed back to the entity, or null if it sent none.

created_atstring date-time

When the hook request was created.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "entity_hook_action_id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
  "entity_name": "application",
  "entity_id": "1234",
  "entity_action": "application:create",
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "type": "hook",
  "when": "before",
  "on": "create",
  "status": "pending",
  "messages": [
    {
      "level": "info",
      "message": "Repository provisioned",
      "timestamp": 1740406453123
    }
  ],
  "callback_body": {
    "repository_url": "https://github.com/my-org/my-service"
  },
  "created_at": "2025-02-13T14:20:43.088Z"
}

Changes

  • 728d4df70ca1Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • ca82c7ad96beRevision changes
    • info

      endpoint added