Integrate using AI

Your AI coding assistant can help you build your Oyster integration faster. With the right context, it can scaffold a new integration, set up authorization, create and submit EOR employments, or handle webhooks, working directly against the Oyster API so the code it writes is correct.

Using llms.txt

We publish a machine-readable index of the entire Oyster developer documentation at https://docs.oysterhr.com/llms.txt. Point your assistant at it and it has every guide and API reference page as context.

Every page listed in llms.txt links to a Markdown version of that page. You can also give your assistant a single page when you are working on one part of your integration. Add .md to the end of any guide or reference URL:

Example prompts

Once you have received access to an Oyster sandbox account created a developer application, you can copy one of these prompts into your assistant to get started:

• “Read https://docs.oysterhr.com/llms.txt. Then write a Node.js function that gets an access token from the Oyster sandbox.”
• “Using https://docs.oysterhr.com/docs/creating-and-submitting-an-eor-employment.md, write the requests to create a draft EOR employment, update the job details, and submit it.”
• “Using https://docs.oysterhr.com/docs/getting-started-with-webhooks.md, build an Express endpoint that receives Oyster webhooks and responds with a 200 status code.”