NUnullplatform
Inbox rules

Send a notification from an inbox rule

Changed on

Sends a notification from one of your invoked inbox rules: the resource the event is about (nrn) and the data the rule's templates read (context).

Sends are idempotent by context.id. Sending the same id for the same nrn again answers 200, marks each entry in emitted with existing: true, and creates nothing. Sending it for a different nrn answers 409.

Recipients who can't see the resource are left out and counted in rejected, and people who turned the rule off for that resource don't receive it.

post/communications/inbox_rule/{id}/emission

Request

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

Path parameters

idstring required

The ID of the inbox rule, like acme.security_finding or deployment.failed.

Query parameters

dry_run'true' | 'false'

Set to true to see what would be sent, to how many people, and why a reading would reach nobody, without sending anything.

Request body

nrnstring required

The NRN of the resource the event is about. It must be inside your organization, and inside the rule's visible_to.

contextobject required

The data the rule's templates read. It must match the rule's context_schema, which always requires id.

deliver_to'me'

Set to me to send the rule's first reading to yourself only, as a test.

Example request

{
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "context": {
    "id": "finding-8812",
    "service": "payments-api",
    "summary": "CVE-2026-1234 in a transitive dependency",
    "owner_id": 50
  },
  "deliver_to": "me"
}

Response

A retry of an earlier send, nobody was left to notify, or a dry run.

With dry_run=true, the body describes what would be sent: would_emit, rejected, and unreached when a reading would reach nobody.

OR

Example response

{
  "emitted": [
    {
      "id": "6f1c2b9e-3a41-4f0e-9d55-2b7c1e0a9f13",
      "as": "owner",
      "recipients": 1,
      "existing": true
    }
  ],
  "test": true
}

Changes