TECH Blogs

Creating Developer Accounts for Zendesk and Slack

—

by

admin
in

To integrate with Zendesk and Slack APIs for development and testing (e.g., populating demo data), you’ll need developer or sandbox accounts. These allow you to experiment without affecting production environments. Below are step-by-step instructions for setting up developer accounts for each.

Zendesk Developer Account

Zendesk provides a free trial or sandbox environment for developers to test API integrations.

  1. Sign Up for a Zendesk Account:
    • Go to the Zendesk website (zendesk.com) and click on “Get started” or “Sign up for free.”
    • Fill in your details: Provide an email, company name, and create a subdomain (e.g., yourcompany.zendesk.com). This will be your ZENDESK_SUBDOMAIN.
    • Complete the captcha and verification email process.
    • Zendesk offers a 14-day free trial; no credit card is required initially.
  2. Enable API Access:
    • Once logged in, go to the Admin Center (gear icon in the top right) > Apps and integrations > APIs > Zendesk API.
    • Enable “Password access” or “Token access” (recommended for security).
    • Generate an API token: Click “Add API token,” give it a name (e.g., “Demo Data Loader”), and copy the token. This is your ZENDESK_API_KEY.
    • Note your email (ZENDESK_EMAIL) as it will be used with the API key for authentication.
  3. Set Up a Sandbox (Optional but Recommended):
    • In the Admin Center, go to Account > Sandboxes.
    • Create a new sandbox environment to isolate your testing data from the main account.
    • This clones your main instance but keeps data separate.
  4. Verify Permissions:
    • Ensure your user role has admin privileges to create tickets via API. If needed, adjust roles in Admin Center > People > Roles.

After setup, you can use the API to create tickets, as described in the demo scripts.

Slack Developer Account

Slack allows you to create apps and bots for API integration via their developer platform.

  1. Sign Up for a Slack Account:
    • Go to slack.com and click “Get started” or “Create a new workspace.”
    • Enter your email and follow the prompts to create a free workspace (no credit card needed). This is a basic plan suitable for development.
  2. Create a Slack App:
    • Go to the Slack API dashboard (api.slack.com/apps).
    • Click “Create New App” > “From scratch.”
    • Name your app (e.g., “Demo Data Populator”) and select your workspace.
    • This creates an app with a bot user.
  3. Configure Bot Permissions (Scopes):
    • In the app settings, go to “OAuth & Permissions.”
    • Under “Scopes” > “Bot Token Scopes,” add permissions like: chat:write (to post messages), channels:manage (to create channels if needed), channels:read (to view channels).
    • Scroll up and click “Install to Workspace” to generate tokens.
    • Copy the “Bot User OAuth Token” (starts with xoxb-). This is your SLACK_TOKEN. (Note: The document mentions xoxp-, but for bots, xoxb- is standard; use whichever your script requires.)
  4. Set Up Channels for Testing:
    • In your Slack workspace, create channels like #customer-support and #billing-support manually or via API if your bot has permissions.
    • Invite the bot to these channels: In the channel, type /invite @botname.
  5. Test API Access:
    • Use the Slack API tester (api.slack.com/methods) to verify your token works, e.g., test chat.postMessage to send a sample message.

This setup allows your scripts to post messages as a bot without needing production data.

Prerequisite Steps to Load Data into Zendesk, Slack, and PostgreSQL Database

Based on the provided demo data setup, here are the prerequisite steps to prepare your environment and load data into Zendesk, Slack, and PostgreSQL (Postgres). These assume you’re using the scripts from the demo_data directory. Run these in a Python environment (e.g., virtualenv).

General Prerequisites

  • Install Python and Dependencies:
    • Ensure Python 3.8+ is installed.
    • Install required libraries via pip (some may already be in a requirements.txt):
Copy Code
pip install httpx 
# For Zendesk API 
pip install slack-sdk 
# For Slack API 
pip install sqlalchemy psycopg2-binary # For PostgreSQL
  • Set Up Environment Variables:
    • Create a .env file or export variables in your shell. Use the values from your developer accounts:
    • Source the variables: source .env (or equivalent on Windows).
Copy Code
# Zendesk 
export ZENDESK_SUBDOMAIN="your_subdomain" 
# e.g., mydev.zendesk.com 
export ZENDESK_EMAIL="your_email@example.com" 
export ZENDESK_API_KEY="your_api_key" 
# Slack 
export SLACK_TOKEN="xoxp-your-slack-bot-token" 
# PostgreSQL Database 
export DATABASE_URL="postgresql://username:password@localhost/dbname" 
# e.g., postgresql://ordruser:Admin123@localhost/ordrmgmnt
  • Prepare the Sample Data:
    • Ensure sample_data.json exists in the directory with the required data (tickets, orders, messages).
    • Customize it if needed (e.g., add more entries).

Loading Data into Zendesk

  1. Verify Zendesk Setup:
    • Confirm API credentials work by testing a simple API call (e.g., via curl or Postman).
  2. Run the Script:
    • python demo_data/populate_zendesk.py
      • This creates 5 sample tickets using the data from sample_data.json.
      • Expected output: Confirmation of created tickets (e.g., ticket IDs).

Loading Data into Slack

  1. Verify Slack Setup:
    • Ensure channels like #customer-support and #billing-support exist (create them in Slack if not).
    • Test bot permissions by manually inviting the bot and posting a test message via API.
  2. Run the Script:
    • python demo_data/populate_slack.py
      • This posts 6 sample messages to the channels.
      • Expected output: Confirmation of posted messages.

Loading Data into PostgreSQL Database

  1. Set Up the Database:
    • Install PostgreSQL if not already (e.g., via Homebrew on macOS: brew install postgresql, or download from postgresql.org).
    • Create the database and user:
Copy Code
psql -U postgres 
# Log in as admin 
CREATE USER ordruser WITH PASSWORD 'Admin123'; CREATE DATABASE ordrmgmnt; GRANT ALL PRIVILEGES ON DATABASE ordrmgmnt TO ordruser;
#Update DATABASE_URL with your credentials.
  1. Run the Script:
    • python demo_data/populate_database.py
      • This creates the orders table (if needed) and inserts 5 sample orders.
      • Expected output: Confirmation of table creation and inserted records.

Loading Data into All (Sequential Execution)

If you want to load everything at once:

Copy Code
python demo_data/populate_database.py
python demo_data/populate_zendesk.py
python demo_data/populate_slack.py

Or create a populate_all.py script to run them in sequence.

Troubleshooting Tips:

  • Check for API rate limits (Zendesk: 700/minute; Slack: varies by endpoint).
  • If errors occur, verify permissions and environment variables.
  • For production-like testing, use sandboxes to avoid data pollution.
  • Always back up any existing data before running scripts.