Initiate (Push + Pull) Session

Time	Status	User Agent
Retrieving recent requests…

name

string

A human-readable label for the session that will appear on the Sessions tab of your dashboard.

category

string

enum

An integration category. If specified, all common data model schemas from the category will be added for this session.

configuration_webhook

object

Endgrate will POST to this webhook when the session is configured by the user.

default_upsert_setting

string

enum

Setting this field changes the default upsert setting shown to the end user on the field mapping page for push transfers. If set to OVERWRITE, any previously existing data will be overwritten for that field. If set to DO_NOT_UPDATE, previously existing data will be preserved. If set to SET_IF_NOT_SET, the field will only be updated if the field has no existing data. The default value if not specified is OVERWRITE.

Allowed:

field_selection

boolean

Defaults to false

Whether or not to allow the user to configure field mapping. See https://documentation.endgrate.com/docs/ux-customization#field-selection for more information.

passthrough_fields

boolean

Defaults to false

Whether or not passthrough fields are allowed. See https://documentation.endgrate.com/docs/passthrough-fields for more information.

passthrough_schemas

boolean

Defaults to false

Whether or not passthrough schemas are allowed. See https://documentation.endgrate.com/docs/passthrough-schemas for more information.

sync

boolean

Defaults to false

Whether or not to return only updated (new) data when pulling data. See https://documentation.endgrate.com/docs/sync for more information.

provider

string

An integration provider. If specified, the user will not be shown the integration provider selection page and instead will be directed to the integration provider authentication page.

integration_provider_list_id

string

An integration provider list ID. If specified, the user will only be shown the integrations described in the integration provider list.

redirect_url

string

A URL that users will be redirected to after setting up the session. This is useful if you want to redirect your users back to your app.

resource_selection

boolean

Defaults to false

Whether or not to allow the user to choose the integrations for a given schema (e.g. choosing "Get Contacts" for a contact schema). See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

save_session

boolean

Defaults to false

Whether or not the session should be persisted permanently. If false, sessions will expire after 72 hours.

schema

array of objects

An array of schemas.

schema

schema_selection

boolean

Defaults to false

Whether or not to allow the user to choose which schemas to pull in and push out. See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

statistics

boolean

Defaults to false

Whether or not to allow the user to see transfer statistics. See https://documentation.endgrate.com/docs/ux-customization#resource-selection for more information.

webhook_concurrency

boolean

Defaults to false

Whether or not to execute POST requests to webhooks concurrently.

200Success

defaultError