KiyOh¶
The KiyOh module allows you to send invites for reviews in your KiyOh account.
Getting Started with KiyOh¶
Prerequisites
- A KiyOh account
In order to use KiyOh with Ibexa Connect, it is necessary to have a KiyOh account. If you do not have one, you can create a KiyOh account at www.kiyoh.com/company_register.php.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting KiyOh to Ibexa Connect¶
To connect your KiyOh account to Ibexa Connect you need to obtain the API Key from your KiyOh account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your KiyOh account.
2. Click Your Account and copy the Connectorcode value to your clipboard.
3. Go to Ibexa Connect and open the KiyOh module's Create a connection dialog.
4. In the Connection name field, enter a name for the connection.
5. In the API Key field, enter the connector code copied in step 2 and click Continue.
Note
The KiyOh API contains no methods to validate the API Key automatically. Ensure to double-check that you have entered the correct value.
The connection has been established.
Actions¶
Send an Invite¶
Schedules a review invite.
| Location ID | Enter the Location ID for which the invite is being sent to. |
| Enter the email address of the member to whom you are sending the invite. | |
| Language Code | Enter the language code. For example, nl for Dutch. The language code is case sensitive. |
| Delay | Enter the number of days after which the email invite should be sent for review. The default is 0. |
| First Name | Enter the first name of the person. |
| Last Name | Enter the last name of the person. |
| Reference | Enter the reference source details from where you receive the member details to send the review invite. |