Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Surveymonkey: Destination Connector #392

Open
Mohith93 opened this issue Sep 30, 2024 · 2 comments
Open

Surveymonkey: Destination Connector #392

Mohith93 opened this issue Sep 30, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request feature_request

Comments

@Mohith93
Copy link

**Feature Request: SurveyMonkey Destination Connector

Issue Type: New Feature / Connector Request

Description

We need to build a SurveyMonkey Destination Connector that allows users to send data from Multiwoven to their SurveyMonkey account. This connector will help users automate survey creation, response management, and integrate data such as customer feedback or survey results between Multiwoven and SurveyMonkey.

Requirements

  • Authentication:
    The connector should support OAuth 2.0 authentication to interact securely with SurveyMonkey’s API. Users will need to generate an access token via the SurveyMonkey OAuth process.

  • Configuration:
    The connector should require the following configuration parameters:

    • access_token: OAuth access token for interacting with the SurveyMonkey API.
    • survey_id: The ID of the survey where data will be sent or managed.
    • Optional: collector_id for associating responses with a particular collector (email, web link, etc.).
  • Connector Features:
    The destination connector should be able to:

    1. Sync the following data to SurveyMonkey:
      • Create new surveys with predefined questions.
      • Send responses or data to an existing survey (e.g., customer feedback or survey results).
      • Retrieve and sync responses from SurveyMonkey to Multiwoven.
    2. Allow users to map their data fields from Multiwoven to SurveyMonkey fields, such as:
      • Questions, answer choices, and response data.
  • API Interaction:
    The connector should use the SurveyMonkey API to interact with surveys and responses. API documentation can be found here:
    SurveyMonkey API Documentation

  • Data Format:
    Data sent to SurveyMonkey must follow the required structure for surveys and responses. This includes correctly formatting questions, answer choices, and response data as defined by the SurveyMonkey API.

  • Error Handling:
    The connector should handle errors gracefully, including:

    • Invalid access tokens.
    • Survey or collector ID mismatches.
    • API rate limits or quota issues.

Steps to Implement

  1. Authentication Setup:

    • Implement OAuth 2.0 authentication to securely connect to the SurveyMonkey API.
  2. Connector Configuration:

    • Create a configuration file that accepts the required parameters, such as access_token, survey_id, and collector_id.
  3. API Integration:

    • Implement the logic to:
      • Create and configure surveys in SurveyMonkey using predefined templates or questions.
      • Send response data from Multiwoven to SurveyMonkey.
      • Retrieve survey responses from SurveyMonkey for analysis in Multiwoven.
  4. Field Mapping:

    • Allow users to map data fields from Multiwoven to SurveyMonkey survey questions and response fields.
    • Handle mapping for both predefined and custom survey questions.
  5. Error Handling & Logging:

    • Implement error handling for issues like authentication failures, invalid survey or collector IDs, and rate limiting.
    • Provide detailed logs for successful and failed data syncs.
  6. Testing:

    • Write unit tests and integration tests to verify that the connector functions correctly.
    • Simulate API interactions using mocks to test survey creation and response submission.
  7. Documentation:

    • Provide a detailed README.md explaining how to configure and use the connector.
    • Include examples of survey creation, response submission, and field mappings.

Acceptance Criteria

  • The connector successfully syncs data with SurveyMonkey, including survey creation, response submission, and retrieving survey data.
  • Proper error handling is implemented, with detailed logs for troubleshooting.
  • Unit and integration tests provide coverage for all key scenarios, including survey creation, response management, and error handling.
  • Comprehensive documentation is provided for users to configure and use the connector.

Resources

Copy link

linear bot commented Sep 30, 2024

@Raushan998
Copy link

@Mohith93 can you assign me this task?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature_request
Projects
None yet
Development

No branches or pull requests

2 participants