Oyster

Automated Global Employment Platform

Go to site
Explore
/
Apps
/
Oyster

Oyster API Integrations

Build and run workflows using the Oyster API. Use 1000s of source-available triggers and actions across 2,100+ apps. Or write custom code to integrate any app or API in seconds.

Overview

The Oyster API allows you to streamline your global employment processes by providing programmatic access to their HR platform. With it, you can automate tasks like managing employee details, handling payroll, and tracking time off. Pipedream, as a serverless integration platform, makes it simple to create workflows that connect the Oyster API with hundreds of other apps. This can help in automating HR operations, syncing employee data across systems, or even sending notifications when certain HR events occur.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    oyster: {
      type: "app",
      app: "oyster",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://api.oysterhr.com/v1/company`,
      headers: {
        Authorization: `Bearer ${this.oyster.$auth.oauth_access_token}`,
      },
    })
  },
})

Choose an API to Connect with Oyster API

1
-
24
of
2,100+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Example Use Cases

  • Employee Onboarding Automation
    When a new employee is added in Oyster, trigger a Pipedream workflow that creates accounts for them in other tools like Slack, Google Workspace, or GitHub, assigns to-dos in a project management tool like Trello or Asana, and sends a welcome email via SendGrid or Mailgun.

  • Payroll Processing Notification
    Set up a workflow that listens for payroll processing events in Oyster. When payroll is processed, the workflow can notify finance or the employee's manager in Slack or Microsoft Teams, log the event in a Google Sheet for record-keeping, and even trigger an email summary via Amazon SES or another email service.

  • Time Off Sync and Alert
    Create a pipeline that monitors time-off requests in Oyster. Once approved, the workflow can block out time on the employee’s calendar in Google Calendar or Outlook, send a message to their team’s Slack channel to inform of the absence, and update any relevant task deadlines in project management tools like Asana or Jira.

Add Single Row with Google Sheets API on New Time Off Request from Oyster API
Oyster + Google Sheets
 
Try it
Send Message with Slack API on New Time Off Request from Oyster API
Oyster + Slack
 
Try it
Get Film with SWAPI - Star Wars API on New Time Off Request from Oyster API
Oyster + SWAPI - Star Wars
 
Try it
Send SMS with Twilio API on New Time Off Request from Oyster API
Oyster + Twilio
 
Try it
Search Tweets with Twitter API on New Time Off Request from Oyster API
Oyster + X (Twitter)
 
Try it
New Engagement from the Oyster API

Emit new event when a new engagement is added. See the documentation

 
Try it
New Expense from the Oyster API

Emit new event when a new expense is created in Oyster. See the documentation

 
Try it
New Time Off Request from the Oyster API

Emit new event when a new time off request is made. See the documentation

 
Try it

Authentication

Oyster uses OAuth authentication. When you connect your Oyster account, Pipedream will open a popup window where you can sign into Oyster and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Oyster API.

Pipedream requests the following authorization scopes when you connect your account:

OAuth Request Configurations:
  1. authorization
    GEThttps://app.oysterhr.com/oauth/authorize/wm3CHB3U?client_id={{oauth.client_id}}&redirect_uri={{oauth.redirect_uri}}&state={{oauth.state}}&response_type=code&scope={{oauth.space_separated_scopes}}
  2. accessToken
    POSThttps://api.oysterhr.com/oauth2/tokencontent-type: application/x-www-form-urlencodedaccept: application/json
    client_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&redirect_uri={{oauth.redirect_uri}}&grant_type=authorization_code&code={{oauth.code}}
  3. refreshToken
    POSThttps://api.oysterhr.com/oauth2/tokencontent-type: application/x-www-form-urlencodedaccept: application/json
    client_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}