Overview

The Wootric REST API allows Birdie to access Wootric’s customer feedback data. This includes retrieving information on NPS survey responses. See the Wootric's REST API documentation for more information about it's functionalities and usability.

Requirements

To access data through the Wootric API, we support authentication using API credentials:

Client ID: Unique identifier for your application.
Client Secret: Secret key for your application.

To obtain the client_id and client_secret for the Wootric API, you’ll need an admin account on the Wootric platform and follow these steps:

Log into your Wootric Account.
In the Wootric dashboard, navigate to the integration settings. The path may vary slightly depending on the version, but it’s typically found in the main menu under Settings or Integrations.

Within the Integrations section, look for a subsection called API or API Keys.

You can re-generate your client_id and client_secret or just make sure to store the pre-generated ones in a secure location, as Birdie'll need them to make requests to the API.

Note: depending on your account and the data you wish to integrate, you might need to configure specific permissions for that data. Confirm with Wootric or consult the API documentation to see if you need to request any additional scopes.

Integration with Birdie

NPS Import Process and Update Frequency

Birdie imports Wootric NPS responses by checking for updates through the created_at field, ensuring that the latest modifications are reflected in Birdie. This method enables Birdie to capture only the most recent changes without re-importing old data.

Endpoint access

Survey responses

Endpoint

https://api.wootric.com/v1/responses

Data collected from the Wootric REST API

[
    {
        "id": 1,
        "end_user_id": 1,
        "survey_id": 1,
        "score": 0,
        "text": "Better performance would mean a higher score. Site is often slow.",
        "completed": false,
        "excluded_from_calculations": false,
        "ip_address": "127.0.0.1",
        "origin_url": "https://wootric.com",
        "created_at": "2016-12-16 09:05:00 -0800",
        "updated_at": "2016-12-16 09:05:13 -0800",
        "tags": [
            "PERFORMANCE"
        ],
        "notes": [],
        "end_user": {
            "properties": {
                "persona": "Individual",
                "pricing_plan": "Small Business",
                "product_plan": "Mobile",
                "purchase_date": 1473177881,
                "revenue_amount": 5000,
                "items_array": "item1, item2"
            }
        }
    }
]

Feedback built for the Birdie App

{
    "language": "und",
    "posted_at": "2016-12-16 09:05:00 -0800",
    "text": "Better performance would mean a higher score. Site is often slow.",
    "kind": "nps",
    "rating": 0,
    "title": "1",
    "additional_fields": {
        "completed": false,
        "end_user.persona": "Individual",
        "end_user.pricing_plan": "Small Business",
        "end_user.product_plan": "Mobile",
        "end_user.purchase_date": 1473177881,
        "end_user.revenue_amount": 5000,
        "end_user.items_array": "item1, item2"
    }
}

Custom Fields

All the additional data provided by Wootric's REST API that doesn't fit into the previous schema can be imported by Birdie as additional fields which can be used to set up custom fields, enabling text search and filtering within them.

If your Wootric setup includes custom fields for NPS surveys, they can be mapped directly into Birdie, preserving your unique data structure, and will also appear as custom fields, maintaining consistency across both platforms.