---
title: "Classify event"
method: POST
path: "classify"
tags: ["Webhooks"]
---

# Classify event

`POST classify` (webhook)

Delivered when a `classify` function chooses a category for a document. The selected label is in `choice` and matches one of the function version's declared `classifications`.

For signing-secret setup and retry semantics that apply to every variant, see the [Webhooks overview](/api/v3/webhooks).

## Payload

- ClassifyEvent
  - `functionCallTryNumber` integer — The attempt number of the function call that created this event. 1 indexed.
  - `eventID` string, required — Unique ID generated by bem to identify the event.
  - `createdAt` string, date-time — Timestamp indicating when the event was created.
  - `referenceID` string, required — The unique ID you use internally to refer to this data point, propagated from the original function input.
  - `inboundEmail` EventInboundEmail
    - `to` string, required — The email address of the recipient.
    - `deliveredTo` string — The email address of the original intended recipient if the email itself was forwarded.
    - `from` string, required — The email address of the sender.
    - `subject` string, required — The subject of the email.
  - `metadata` object
    - `durationFunctionToEventSeconds` number
  - `eventType` 'classify'
  - `functionCallID` string — Unique identifier of function call that this event is associated with.
  - `functionID` string, required — Unique identifier of function that this event is associated with.
  - `functionName` string, required — Unique name of function that this event is associated with.
  - `functionVersionNum` integer — Version number of function that this event is associated with.
  - `callID` string — Unique identifier of workflow call that this event is associated with.
  - `workflowID` string — Unique identifier of workflow that this event is associated with.
  - `workflowName` string — Name of workflow that this event is associated with.
  - `workflowVersionNum` integer — Version number of workflow that this event is associated with.
  - `choice` string, required — The classification chosen by the classify function.
  - `s3URL` string — The presigned S3 URL of the file that was classified.

## Acknowledgement `2XX`

Return any 2XX status code to acknowledge receipt. The exact code is not inspected.

---

[API](https://skmtc.dev/bem-team/apis/bem-api.md) · [All operations](https://skmtc.dev/bem-team/apis/bem-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bem-team/bem-api/revisions/a6e4624117c6/schema)
