Skip to navigation
Webhooks

On Flow Started

View as Markdown

Triggered when your customer opens the Spain Public Administration widget and the session goes live.

data is the browser context it was opened with — origin, user agent, address — the first line of the audit trail of this session. Nothing has been retrieved yet.

What data carries, and what actually travels

The schema below describes data decrypted — on purpose, so this reference has a model you can read and code against. What arrives at your endpoint depends on how the session was created:

  • With an aes_key: data is a single string, aes::Base64(IV + Ciphertext + Tag). Decrypt it and you get exactly the object documented below. The walkthrough and the code are in Payload Encryption.
  • Without an aes_key: data is not in the body at all — absent, not null. Somebody’s records are never put on the wire unencrypted, so the event tells you what happened and you read the content from Get Session Results when it arrives.

Answer 2xx as soon as the payload reaches you, whatever your processing does with it afterwards: any other status is recorded as a failed delivery even though the event arrived. Answering a delivery has the handler to copy.

Payload

The payload of this webhook request is an object.
event_class"EsPublicAdministrationV1FlowEvent"Required

Payload class discriminator — always this value for Spain Public Administration events.

app_idstringRequiredformat: "object-id"
customer_idstringRequired1-64 characters
session_idstringRequiredformat: "object-id"
producer"es-public-administration"Required
The flow that produced the event.
event"es-public-administration:started"Required

The event type: started.

status_codeenumRequired
Describes the status of a flow.
datestringOptionalformat: "datetime"
status_messagestring or nullOptional
dataobjectOptional

The browser context the session was opened with. Documented decrypted: on the wire it is the aes::… string of this object when the session carries an aes_key, and absent when it does not.

Response

200
Successful Response
422
Validation Error