Breezy

​

What’s supported

​

Supported actions

This connector supports:

• Read Actions, including full historic backfill. Incremental read is supported for positions only. For all other objects, a full read will be done on each scheduled read.
• Write Actions (create/update) for positions only.
• Proxy Actions, using the base URL https://api.breezy.hr.
• Subscribe Actions are not currently supported.

​

Supported objects

For objects and fields, you can also use Ampersand’s Object Metadata APIs to inspect what’s available for a specific connection.

​

Notes and limitations

• Published vs draft positions: Write create leaves new positions in draft. The positions Read object returns published job postings only. The connector does not auto-publish on create. When the customer is ready to go live, publish via Proxy Actions: PUT /v3/company/{company_id}/position/{position_id}/state with {"state":"published"}. Until published, the job will not appear in Read webhooks. Publish is intentional — Breezy does not support unpublishing.
• Incremental read: Incremental read is supported for positions only (filtered by updated_date). Scheduled reads emit only positions updated since the last sync. companies, pipelines, categories, departments, questionnaires, and templates are read in full on each scheduled read.
• Pipelines: Breezy returns a map of pipeline id → pipeline object (e.g. default, default_pool).
• API key expiry: Breezy access tokens from /v3/signin expire after approximately 30 days.

​

Example integration

To define an integration for Breezy, use a manifest file (amp.yaml). For a complete example, visit our samples repo on Github.

​

Before you get started

To connect Breezy with Ampersand, you will need a Breezy account. Once your account is created, you’ll need to obtain an API Key — a Breezy access token used as the Authorization header on API requests. Your customers enter this when they install the integration via the InstallIntegration UI.

​

Create a Breezy account

Here’s how you can sign up for a Breezy account:

• Sign up at Breezy.

​

Obtain API credentials

Follow the steps below to obtain your API key from Breezy:

1. Call Breezy’s sign-in endpoint with a user that has API access. See Authorization.
   curl -H "Content-Type: application/json" \
     -X POST \
     -d '{"email":"user@example.com","password":"YOUR_PASSWORD"}' \
     https://api.breezy.hr/v3/signin
   
   Use the access_token value from the response as the API key.

​

Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) The API key is sent in the Authorization header with no prefix, per Breezy’s documentation. To start integrating with Breezy:

• Create a manifest file; see Example integration.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for their API key.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls. Ampersand will automatically attach the API key for the connected account.