POST /protect/event/send

Send a new event to enrich user data and optionally get a Trust Index score for the event.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`protect_sdk_session_id`	String	No	Protect SDK session id should be provided for any event correlated with a frontend user session
`timestamp`	String	No	Timestamp of the event. Might be the current moment or a time in the past. In ISO 8601 format, e.g. `"2017-09-14T14:42:19.350Z"`
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`event`	Object	Yes	Event data for Protect events.
`event.timestamp`	String	Yes	The timestamp of the event, in ISO 8601 format, e.g. `"2017-09-14T14:42:19.350Z"`
`event.protect_session_id`	String	No	If present, contains the current Protect Session ID from the Plaid Pixel SDK.
`event.user_sign_up`	Object	No	This event type represents a user signing up for the application.
`event.app_visit`	Object	No	This event type represents a user visiting the client application.
`event.user_sign_in`	Object	No	This event type represents a user signing in to the application.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
`request_trust_index`	Boolean	No	Whether this event should be scored with Trust Index. The default is false.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.