Integration Setup Sessions

Create integration setup session

Creates a new integration setup session. Creates a draft integration instance unless integration_instance_id is given, in which case that instance is reused and its config and auth config are overwritten on completion.

post/integration-setup-sessions

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

integration_idstring required
integration_instance_idstring
namestring required
descriptionstring
metadataobject
identity_actor_idstring nullable
identity_idstring nullable
expires_atstring date-time
redirect_urlstring

Response

Successful response

object'integration.setup_session' required
idstring required
status'pending' | 'successful' | 'expired' | 'archived' | 'deleted' required
urlstring required
namestring nullable required
descriptionstring nullable required
metadataobject nullable required
configurationobject nullable required
redirect_urlstring nullable required
integration_idstring required
created_atstring date-time required
updated_atstring date-time required
expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.