Custom OAuth profiles

Use the endpoints below to manage custom OAuth profiles programmatically.

Quick reference

Type	Resource	Description
GET	/api/custom_oauth_profiles	List Custom OAuth profiles.
GET	/api/custom_oauth_profiles/:id	Get a Custom OAuth profile by ID.
POST	/api/custom_oauth_profiles	Create a Custom OAuth profile.
PUT	/api/custom_oauth_profiles/:id	Update a Custom OAuth profile.
DELETE	/api/custom_oauth_profiles/:id	Delete a Custom OAuth profile.

List Custom OAuth profiles

List custom OAuth profiles. Client secrets and tokens are never returned in the response.

GET /api/custom_oauth_profiles

Query parameters

Name	Type	Description
page	integer	Page number. Defaults to 1.
per_page	integer	Page size. Defaults to 100 (maximum is 100).

Sample request

curl  -X GET 'https://www.workato.com/api/custom_oauth_profiles' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response

{
  "result": [
      {
        "id": 321,
        "user_id": 123,
        "name": "Acme HubSpot OAuth app",
        "provider": "hubspot",
        "data": {
          "client_id": "example_client_id"
        },
        "shared_accounts_count": 1,
        "oem_customers_count": 5,
        "created_at": "2023-01-15T11:50:32.986-07:00",
        "updated_at": "2023-01-15T11:50:32.986-07:00"
      }
    ]
}

Get Custom OAuth profile by ID

Retrieves a custom OAuth profile by ID. Client secrets and tokens are never returned in the response.

GET /api/custom_oauth_profiles/:id

Path parameters

Name	Type	Description
id	integer required	ID of the Custom OAuth profile to retrieve

Sample request

curl  -X GET 'https://www.workato.com/api/custom_oauth_profiles/321' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response

{
  "result": {
    "id": 321,
    "user_id": 123,
    "name": "Acme HubSpot OAuth app",
    "provider": "hubspot",
    "data": {
      "client_id": "example_client_id"
    },
    "shared_accounts_count": 1,
    "oem_customers_count": 5,
    "created_at": "2023-01-15T11:50:32.986-07:00",
    "updated_at": "2023-01-15T11:50:32.986-07:00"
  }
}

Create a Custom OAuth profile

Create a Custom OAuth profile.

POST /api/custom_oauth_profiles

Payload

Name	Type	Description
name	string required	The name of the OAuth profile.
provider	string required	The name of the app tied to this Custom OAuth profile.
data.client_id	string required	The Client ID of the Custom OAuth App
data.client_secret	string required	The Client secret of the Custom OAuth App
data.token	string optional	Only required for Slack Apps. The token of the Custom OAuth App

Sample request

curl  -X POST https://www.workato.com/api/custom_oauth_profiles \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ 
            "name": "My new OAuth profile",
            "provider": "hubspot"
            "data": { 
              "client_id": "new_client_id", 
              "client_secret": "new_client_secret"
            }
          }'

Response

{
  "result": {
    "id": 322,
    "user_id": 123,
    "name": "My new OAuth profile",
    "provider": "hubspot",
    "data": {
      "client_id": "example_client_id"
    },
    "shared_accounts_count": 0,
    "oem_customers_count": 0,
    "created_at": "2023-01-15T11:50:32.986-07:00",
    "updated_at": "2023-01-15T11:50:32.986-07:00"
  }
}

Update a Custom OAuth profile

Update a Custom OAuth profile.

PUT /api/custom_oauth_profiles/:id

Path parameters

Name	Type	Description
id	integer required	ID of the Custom OAuth profile to update

Payload

Name	Type	Description
name	string required	The name of the OAuth profile.
provider	string required	The name of the app tied to this Custom OAuth profile.
data.client_id	string required	The Client ID of the Custom OAuth App
data.client_secret	string required	The Client secret of the Custom OAuth App
data.token	string optional	Only required for Slack Apps. The token of the Custom OAuth App

Sample request

curl  -X PUT https://www.workato.com/api/custom_oauth_profiles/322 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ 
            "name": "My updated OAuth profile",
            "provider": "hubspot"
            "data": { 
              "client_id": "updated_client_id", 
              "client_secret": "updated_client_secret"
            }
          }'

Response

{
  "result": {
    "id": 322,
    "user_id": 123,
    "name": "My updated OAuth profile",
    "provider": "hubspot",
    "data": {
      "client_id": "updated_client_id"
    },
    "shared_accounts_count": 0,
    "oem_customers_count": 0,
    "created_at": "2023-01-15T11:50:32.986-07:00",
    "updated_at": "2023-01-15T11:50:32.986-07:00"
  }
}

Delete a Custom OAuth profile

Delete a Custom OAuth profile.

DELETE /api/custom_oauth_profiles/:id

Path Parameters

Name	Type	Description
id	integer	ID of the Custom OAuth profile to delete

Sample request

curl  -X DELETE https://www.workato.com/api/custom_oauth_profiles/322 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response

{
  "result": {
    "success": true
  }
}