Event Types

List of supported event types and their payload.

verification.updated

Occurs whenever a production verification has been completed.

{
  "event": "verification.updated",
  "verificationId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "id": "123456",
  "status": "complete.eligible"
}

sandbox.verification.updated

Occurs whenever a sandbox verification has been completed.

{
  "event": "sandbox.verification.updated",
  "verificationId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "id": "123456",
  "status": "complete.eligible"
}

verification.pending

Occurs whenever a production verification has not been resolved immediately.

{
  "event": "verification.pending",
  "verificationId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "id": "123456",
  "status": "pending"
}

sandbox.verification.pending

Occurs whenever a sandbox verification has not been resolved immediately.

{
  "event": "sandbox.verification.pending",
  "verificationId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "id": "123456",
  "status": "pending"
}

discovery.updated

Occurs whenever a discovery request is updated.

{
  "event": "discovery.updated",
  "discoveryId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "status": "complete",
  "id": "123456"
}

sandbox.discovery.updated

Occurs whenever a sandbox discovery request is updated.

{
  "event": "sandbox.discovery.updated",
  "discoveryId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "status": "complete",
  "id": "123456"
}

flow.updated

Occurs when the status or state of a Flow Run is updated.

{
  "event": "flow.updated",
  "flowRunId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "status": "COMPLETE",
  "stateId": "create-verification"
}

sandbox.flow.updated

Occurs when the status or state of a sandbox Flow Run is updated.

{
  "event": "sandbox.flow.updated",
  "flowRunId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "status": "ERROR",
  "stateId": "create-verification"
}

flow.callback

Occurs when a Flow Run reaches a callback state and is waiting for additional input.

{
  "event": "flow.callback",
  "flowRunId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "input": {
    "type": "object",
    "properties": {
      "memberId": {
        "type": "string"
      }
    }
  }
}

sandbox.flow.callback

Occurs when a sandbox Flow Run reaches a callback state and is waiting for additional input.

{
  "event": "sandbox.flow.callback",
  "flowRunId": "990cdad8-1438-4bbd-8b55-120b56e87540",
  "input": {
    "type": "object",
    "properties": {
      "memberId": {
        "type": "string"
      }
    }
  }
}