Skip to content

Post Event

Request

Signs a security signal as a Security Event Token and delivers it to the receiver configured with the token used for authentication. A success response means the receiver accepted the token. It does not mean the receiver acted on it.

Operation ID: ssf_post_event

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

Bodyapplication/jsonrequired

The security signal. Supply the subject as a top-level sub_id and the event under events, keyed by event type URI. If you declare a mapping on this operation, post your own format instead: the mapping runs first, and its output is what must be a valid Security Event Token.

any
curl
curl -i -X POST \
  https://api.synqly.com/v1/ssf/events \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json
resultobject(SsfEventResult)required
messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": { "event_id": "string" }, "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }