OpenApply
To authenticate the OpenApply connector you will need a Client ID, Client Secret and the name of you account.
Client ID & Client Secret
To obtain your Client ID and Client Secret, within your OpenApply account:
Navigate to Settings and open the Public API page for which you would like to add a new application.
You will find your Client ID, Client Secret, and Redirect URI on this page.
Redirect URI should be {% raw %}https://{{Your Cyclr service domain e.g. http://app-h.cyclr.com }}/connector/callback{% endraw %}
OpenApply Account (name)
Your OpenApply account as displayed in your account URL. Example: if your account URL was https://demo.openapply.com then your account name would be demo.
Connector Setup
Locate the OpenApply connector
Cyclr Console > Connectors > Connector Library > OpenApply
From the Edit Connector interface click 'Setup'
Enter your Client ID, Client Secret and OpenApply Account Name, click 'Next'
The connector is now authenticated and ready to use.
Custom fields
Student and Parent objects support the use of custom fields.
The correct Field Location format for each of the supported methods is as follows:
Method Name | Field Location | Example |
---|---|---|
Get Parent By ID | parent.custom_fields.FieldName | parent.custom_fields.eyeColour |
List Parents | [parents].custom_fields.FieldName | [parents].custom_fields.eyeColour |
List Updated Parents | [parents].custom_fields.FieldName | [parents].custom_fields.eyeColour |
Search Parents | [parents].custom_fields.FieldName | [parents].custom_fields.eyeColour |
Get Student By ID | student.custom_fields.FieldName | student.custom_fields.eyeColour |
List Students | [students].custom_fields.FieldName | [students].custom_fields.eyeColour |
List Updated Students | [students].custom_fields.FieldName | [students].custom_fields.eyeColour |
Search Students By Field Value | [students].custom_fields.FieldName | [students].custom_fields.eyeColour |
Search Students By Student Slug | [students].custom_fields.FieldName | [students].custom_fields.eyeColour |
Search Students By Tag | [students].custom_fields.FieldName | [students].custom_fields.eyeColour |
For more information, see the Cyclr documentation on how to add custom fields to a method.