Village Product and Developer Docs
  • 📘Welcome to Village Labs
    • Welcome to Village Labs
    • Self Service Onboarding
    • Help Pages
      • Adding and Deleting Users
      • Mapping Users to Source tool IDs
      • How to follow or unfollow other users
      • Configuring & Removing Daily Slack Notification Whitelist
      • Changing the Reporting Lines & Teams
      • Following Custom Reports
      • Google Drive Privacy: When will my documents appear in Village Reports?
    • Custom Reports
      • Creating Team Reports
      • Creating Custom Reports & Custom Prompt Library
    • Meetings
      • Connecting your Calendar
      • Configuring your Meetings
      • Meeting Summary Reports
    • Village Assistant
      • Github PR Review Tool
    • Security & Compliance
    • Data Privacy & Permissions
  • 🔌Data Connections
    • Airtable
    • Ashby
    • Clickup
      • Finding ClickUp User IDs
    • Figma
    • Github
      • Finding GitHub User IDs
    • Gitlab
    • Google - OAuth (Recommended)
    • Google - Manual Connection
    • Hubspot
    • Jira
      • Finding Jira User IDs
    • Confluence
      • Finding Confluence / Jira User IDs
    • Linear
    • Asana
    • Monday
    • Notion
    • Pipedrive
    • Slack
    • Basecamp
    • Zoom
  • 👩‍💻Legacy Developer Docs
    • Developer Quickstart
    • Village APIs: Introduction
      • Activity API
      • User Status API
      • Patch User API
      • Segments API
      • Redemption API
      • Master Award Controls
      • Connections (Referrals) APIs
      • GET APIs
    • 3rd Party Payments Integrations
    • Embedding Village Dashboards
  • 🕵️LEGACY Knowledge Base
    • Admin Quickstart
    • Referrals Support
    • The Basics of Village in 15 Minutes
    • Programs & Rules
      • Triggers
        • Activities
        • Goals
      • Conditions
        • Segment Conditions
        • Time Conditions
        • Max Budget Conditions
        • Conditional Multipliers
    • Awards
      • Monetary (Cash) Awards
      • Non-Monetary Awards
        • Funding
          • In-depth use cases for funding pools
      • Badges & Statuses
      • Award Expiration
    • Segments
      • Segmentation Use Cases
    • Rule Evaluation Logic Deep-dive
    • The Village Dashboards
      • Admin Account Creation
      • User Access Management
      • Network Settings
      • User Dashboard
    • BigQuery
    • Managing Payment Integrations
    • Referrals (Connections)
      • Pre-populating Users' Unique Referral Codes In Signup Flows & Forms
  • No and Low Code Solutions
    • No and Low Code Solutions
      • No & Low Code Solutions
  • Feedback
    • Village Docs Feedback Form
    • Feature Requests
    • Talk to our Team
Powered by GitBook
On this page
  • Prequisites
  • Generating the credentials
  • Information required for the Village connection:

Was this helpful?

  1. Data Connections

Ashby

How to connect your Ashby instance.

PreviousAirtableNextClickup

Last updated 9 months ago

Was this helpful?

Prequisites

  • An Ashby account with sufficient permissions

Important note: the scope of the data which will be synchronized to Village is defined by the user behind the API key. We recommend that you create a service account which will have the right permissions, ie. no access to sensitive tasks/data.

Generating the credentials

Log in as the service account which will make the API key, and go to the .

Click on "New" to make a new API key.

The scope required for a Village connection is the following:

The read permission on API keys is required for us to be able to verify the creation of these webhooks, as well as clean them up if the connection needs to be deleted.

No other write permission is required, Village will not be making any write operation on your data.

Information required for the Village connection:

  • api_key: the API key generated above

  • start_date: the date of the first document that should be synchronized. No document updated before that will be synchronized. Format: ISO8601 date, ie. 2024-05-01T00:00:00Z

Note on the read/write API key permission: Village relies on both the standard Ashby API, and webhook data to synchronize your activity. When the connection is made, webhooks will be created, . Please do not disable them, as Village would become unable to get real-time notifications of your activity.

🔌
as can be seen here
API settings page
API Key Permissions