SEEN API 2.0 - Create Data – SEEN Documentation

Create a data item in your workspace.

If your workspace has a Journey with On Create trigger, that Journey will be triggered upon a successful request

Endpoint

https://next.seen.io/v1/workspaces/{Workspace_ID}/data

You can view your workspace ID in your SEEN Platform account URL, e.g. if you are viewing the Dashboard, the URL is https://be.seen.io/{Workspace_ID}/dashboard

Request Method

POST

Request Headers

Authorization

This header is common to all requests to our API. Please see the “Authorization” section for more details.

Content-Type

Content-Type should be configured as application/json

Request Body

Here is an example of a payload. Fields can differ depending on setup.

The expected request body follows the below structure:

{
"id":"12345",
"first_name":"John",
"last_name":"Rowley",
"country":"Norway"
}

ID is a required field, and must be sent as a string.

If Webhook is enabled for a Journey, it's recommended to supply a unique id (id) for each data item, that can be used to match each data item between our respective systems.

Additional fields should match the workspace properties.

SEEN API accepts single JSON objects only. Arrays are not supported at the moment

Images via URL

To be able to send images via URL in an API call, these are the requirements:

Image size limit is 2 MB.

Only use images with file extension .jpg .jpeg or .png (only lowercase extension is allowed).

The image should provide a content type. image/jpg, image/jpeg or image/png.

Only use direct links that do not require authentication to the images. Do not use redirect links.

Here is an example of an image via URL:

https://storage.googleapis.com/landing-page-static-assets-prod/images/logo_black.png

Rate Limit

SEEN API accepts up to 100 requests per 10 seconds.

Responses

Upon posting the request, you will receive one of the following responses from our API:

201

Upon a successful request, you will receive a 201 Created response.

Example response body (based on the example request above):

{
"id":"12345",
"values": {
	"first_name":"John",
	"last_name":"Rowley",
	"country":"Norway"
	}
}

400

Upon a bad request, you will receive a 400 Bad Request response.

Example response body:

{
"code": "ErrRequestBody",
"message": "a JSON object is expected"
}

401

Upon an unauthorized request, you will receive a 401 Unautorized response.

Example response body:

{
"code": "ErrUnauthenticated",
"message": "api key invalid"
}

429

Upon exceeding the rate limit, you will receive a 429 Too Many Requests response.

Example response body:

<!doctype html><meta charset="utf-8"><meta name=viewport content="width=device-width, initial-scale=1"><title>429</title>429 Too Many Requests

500

Upon an invalid request, you will receive a 500 Internal Server Error response.

Example response body:

{
"code": "ErrInvalidRequest",
"message": "ID must be a string"
}