Add a new Integration Type

This endpoint offers you the ability to enable a new integration type in Whisk Studio.

put
Add Integration
https://api.studio.whisk.com/integrations/v1/add
You can specify the following body parameter to enable a new integration type:
Request
Response
Request
Headers
Authentication
required
string
Authentication token to authorize the API usage. For more information, see Authentication.
Body Parameters
body
required
object
This body object contains the integration type that you want to enable in Whisk Studio.
Response
200: OK
This is how a successful response looks.
{
  "integration": {
    "id": "string",
    "type": "INTEGRATION_TYPE_INVALID",
    "status": "INTEGRATION_STATUS_INVALID",
    "created_at": "string",
    "updated_at": "string"
  }
}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
  "error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
  "message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: 
auth.tokenNotFound
, auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
  "code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com
Body Object Example
{
 "type": "INTEGRATION_TYPE_CUSTOM"
}
Note: To learn about the type attribute, see Integrations Object.
Sample Request and Response
Curl Request
Response
Curl Request
curl -X PUT "https://api.studio.whisk.com/integrations/v1/add"
    -H "Accept: application/json" 
    -H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"
    -d "{ \"type\": \"INTEGRATION_TYPE_CUSTOM\"}"
Note: Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.
Response
{
  "integration": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "INTEGRATION_TYPE_CUSTOM",
      "status": "INTEGRATION_STATUS_ENABLED",
      "created_at": "1608910441740",
      "updated_at": "1608910441740"
  }
}
Note: To understand the data structure of the integration definition, see Integrations Object.
​

Whisk Studio Sync API Reference 1.0 - Previous

Integrations

Get Integrations Details

Last updated 1 week ago

Add a new Integration Type

putAdd Integration

Body Object Example

Sample Request and Response

put
Add Integration