Oyster API Integrations
Build and run workflows using the Oyster API. Use 1000s of source-available triggers and actions across 2,000+ 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.
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-24of2,000+apps by most popular
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.
Popular Oyster Integrations#
Popular Oyster Triggers#
Emit new event when a new engagement is added. See the documentation
Emit new event when a new expense is created in Oyster. See the documentation
Emit new event when a new time off request is made. See the documentation
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:
- 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}} - accessToken
POSThttps://api.oysterhr.com/oauth2/tokencontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&redirect_uri={{oauth.redirect_uri}}&grant_type=authorization_code&code={{oauth.code}} - refreshToken
POSThttps://api.oysterhr.com/oauth2/tokencontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}