BigChange JobWatch setup
You need the following information to set up the BigChange JobWatch connector in Cyclr:
- The API key of your BigChange JobWatch account.
- The username and password of your BigChange JobWatch account.
Getting the API key
Please contact your BigChange JobWatch customer service representative if you need help getting your API key.
You will be asked for the following values when installing the BigChange JobWatch connector within an account:
|API Key||The API key of your BigChange JobWatch account.|
|Username||The username of your BigChange JobWatch account.|
|Password||The password of your BigChange JobWatch account.|
Mapping custom fields
The BigChange JobWatch connector has custom field support for several methods. You can find a list of compatiable methods here. To add a custom field to a method:
- Go to the Edit Connector page for the BigChange JobWatch connector.
- Under the Methods & Fields heading, locate the required method by expanding out the categories and method name.
- Select the pink + button to add a method field.
- Enter the following:
Value Description Field Location The custom field location, which must have the format
cust_<custom field name>. The
<custom field name>value has the exact same format as on the contact details page.
Display Name The display name of the custom field within the Cyclr UI. Description The description of the custom field within the Cyclr UI. Data Type The data type of the custom field. This should be set to
- Select Create.
Custom field compatiable methods
You can add custom fields for contacts, contact notes, and jobs in the following methods:
Update Contact Note
You can view custom fields for contacts, contact notes, and jobs in the following methods:
Get Contact Note
List Contact Notes
List Group Jobs
List Jobs by Contact
Search Contacts By Email
Search Contacts By Email, ID, Or Reference
Search Contacts By Phone Number
Search Contacts By Postcode