Environment properties

Use the endpoints below to manage environment properties programmatically.

Quick reference

Type	Resource	Description
GET	/api/properties	Lists environment properties that matches a prefix.
POST	/api/properties	Upserts environment properties.

List properties by prefix

Returns a list of environment properties belonging to a customer that matches a prefix. For example, if the prefix provided is salesforce_sync., any environment property with a name beginning with 'salesforce_sync.' will be returned.

GET /api/properties

Parameters

Name	Type	Description
prefix	string required	Return properties with the given prefix. E.g: salesforce_sync..

Sample request

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

Response

{
  "salesforce_sync.object_name": "Account",
  "salesforce_sync.object_field": "Id"
}

Upsert property

Upserts environment properties. Matches by the names of the properties provided in the request.

POST /api/properties

Payload

Name	Type	Description
properties	Hash required	Contains the names and values of the properties to upsert.

Sample request

curl  -X POST https://www.workato.com/api/properties \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "zendesk.object": "Ticket", "zendesk.key": "ticket_id" }}'

Response

{
  "success": true
}