API reference / Integrations

Integrations API

21 endpoints. Scopes: Scalar360.integrations.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Catalog

/api/v1/integrations/catalog

Scope: Scalar360.integrations.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/catalog" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List

/api/v1/integrations/connections

Scope: Scalar360.integrations.READ

Parameter	In	Type	Required
`type`	query	string	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/connections" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create

/api/v1/integrations/connections

Scope: Scalar360.integrations.CREATE

Body field	Type	Required	Notes
`type`	string
`name`	string	Yes	required, not blank, max length 120
`enabled`	boolean
`targetUrl`	string		max length 2000
`events`	array of string
`inboundAction`	string
`userGids`	array of string

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/connections" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

GET

Get

/api/v1/integrations/connections/{id}

Scope: Scalar360.integrations.READ

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/connections/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update

/api/v1/integrations/connections/{id}

Scope: Scalar360.integrations.UPDATE

Parameter	In	Type	Required
`id`	path	integer	Yes

Body field	Type	Required	Notes
`type`	string
`name`	string	Yes	required, not blank, max length 120
`enabled`	boolean
`targetUrl`	string		max length 2000
`events`	array of string
`inboundAction`	string
`userGids`	array of string

Example request

curl -X PUT "https://api.scalar360.com/api/v1/integrations/connections/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"string","name":"string","enabled":true,"targetUrl":"string","events":["string"],"inboundAction":"string"}'

DELETE

Delete

/api/v1/integrations/connections/{id}

Scope: Scalar360.integrations.DELETE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/integrations/connections/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Deliveries

/api/v1/integrations/connections/{id}/deliveries

Scope: Scalar360.integrations.READ

Parameter	In	Type	Required
`id`	path	integer	Yes
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 25)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/connections/{id}/deliveries" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Enable

/api/v1/integrations/connections/{id}/enable

Scope: Scalar360.integrations.CREATE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/connections/{id}/enable" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Regenerate

/api/v1/integrations/connections/{id}/regenerate-secret

Scope: Scalar360.integrations.CREATE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/connections/{id}/regenerate-secret" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Test

/api/v1/integrations/connections/{id}/test

Scope: Scalar360.integrations.CREATE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/connections/{id}/test" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Resend

/api/v1/integrations/deliveries/{id}/resend

Scope: Scalar360.integrations.CREATE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/deliveries/{id}/resend" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Sample

/api/v1/integrations/events/{key}/sample

Scope: Scalar360.integrations.READ

Parameter	In	Type	Required
`key`	path	string	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/events/{key}/sample" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Subscribe hook

/api/v1/integrations/hooks

Scope: Scalar360.integrations.CREATE

Body field	Type	Required	Notes
`event`	string
`targetUrl`	string

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/hooks" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"event":"string","targetUrl":"string"}'

DELETE

Unsubscribe hook

/api/v1/integrations/hooks/{id}

Scope: Scalar360.integrations.DELETE

Parameter	In	Type	Required
`id`	path	integer	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/integrations/hooks/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Overview

/api/v1/integrations/mail-links

Scope: Scalar360.integrations.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/mail-links" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create

/api/v1/integrations/mail-links

Scope: Scalar360.integrations.CREATE

Body field	Type	Required	Notes
`mailbox`	string
`userId`	string (uuid)

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/mail-links" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mailbox":"string","userId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d"}'

DELETE

Delete

/api/v1/integrations/mail-links/{id}

Scope: Scalar360.integrations.DELETE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/integrations/mail-links/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create mailbox

/api/v1/integrations/mail-links/mailboxes

Scope: Scalar360.integrations.CREATE

Body field	Type	Required	Notes
`email`	string
`name`	string

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/mail-links/mailboxes" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","name":"string"}'

DELETE

Delete mailbox

/api/v1/integrations/mail-links/mailboxes

Scope: Scalar360.integrations.DELETE

Parameter	In	Type	Required
`email`	query	string	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/integrations/mail-links/mailboxes" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Usage

/api/v1/integrations/mail-links/usage

Scope: Scalar360.integrations.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/integrations/mail-links/usage" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Start oauth

/api/v1/integrations/oauth/start

Scope: Scalar360.integrations.CREATE

Body field	Type	Required	Notes
`type`	string
`name`	string
`events`	array of string
`connectionId`	integer

Example request

curl -X POST "https://api.scalar360.com/api/v1/integrations/oauth/start" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"string","name":"string","events":["string"],"connectionId":1}'