WireWheel Connector
The WireWheel connector lets you manage customer consent records through WireWheel in your PingOne DaVinci flow.
The connector displays consent forms and writes consent data to your WireWheel environment so that you can honor user privacy preferences in your flow.
Setup
Resources
You can find more information and setup help in the following:
-
WireWheel documentation:
-
PingOne DaVinci documentation:
Requirements
To use the connector, you’ll need:
-
The Base API URL of your WireWheel environment.
-
The issuer URL, client ID, client secret, and channel ID from your WireWheel channel settings.
Configuring the WireWheel connector
Add the connector in PingOne DaVinci as shown in Adding a connector, then configure it as follows.
Connector configuration
| Setting | Description |
|---|---|
WireWheel Base API URL |
The base API URL of your WireWheel environment, such as https://api.upcp.wirewheel.io. |
Issuer URL |
The issuer URL from your WireWheel channel settings. |
Client ID |
The client ID from your WireWheel channel settings. |
Client Secret |
The client secret from your WireWheel channel settings. |
Using the connector in a flow
Managing consent records in a flow
You can use the connector to retrieve channel information, check for existing consent, display the WireWheel consent form, and write consent data to WireWheel.
At a high level:
-
The Get Channel Information capability retrieves WireWheel channel information using the channel ID from your WireWheel channel settings.
-
The Get Existing Consent capability retrieves the existing consent record for the username you specify.
-
The Consent Form capability displays the WireWheel consent form with a default HTML template, CSS, and script, and writes the submitted consent record to WireWheel.
-
The Write Consent Data capability saves consent data to WireWheel using a properly formatted JSON consent payload.
| The connector verifies a single consent record at a time. |
Test the flow by clicking Save, Deploy, and Try Flow.
Capabilities
Get Channel Information
Retrieve WireWheel Channel Information
Show details
-
Properties
-
Output Schema
- Channel ID textField required
-
Channel ID from WireWheel Channel settings
-
output object
-
channel object
-
Get Existing Consent
Retrieve the existing consent by the username
Show details
-
Properties
-
Output Schema
- Username textField required
-
Username of the consent record
-
output object
-
consent object
-
Consent Form
Displays the WireWheel Consent Form
Show details
-
Properties
-
Output Schema
- Channel ID textField required
-
Channel ID from WireWheel Channel settings
- Username textField required
-
Username of the consent record
- Get Existing Consent toggleSwitch required
-
Toggle to retrieve existing consent record
-
output object
-
consentPayload object
-
writeConsentStatusCode number
-
writeConsentStatusText string
-