@orchesty/connector-workable 1.0.1 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Workable Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-workable)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Workable, the world's leading hiring platform for managing recruitment, job postings, and candidates.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using a Bearer access token in the `Authorization` header. The base URL is constructed from your company subdomain.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `access_token` | Your Workable API access token |
|
|
17
|
+
| `subdomain` | Your Workable company subdomain (e.g. `mycompany`) |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `WorkableGetAccountsBatch` | Batch | Fetches all accounts for the configured subdomain via `GET /spi/v3/accounts` |
|
|
24
|
+
| `WorkableJobsBatch` | Batch | Paginates through published jobs (cursor-based) via `GET /spi/v3/jobs?state=published` |
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
1. Log in to your [Workable](https://www.workable.com/) account.
|
|
31
|
+
2. Navigate to **Settings → Integrations → Access Tokens** and generate a new token.
|
|
32
|
+
3. Your **subdomain** is the part of your Workable URL before `.workable.com` (e.g. `mycompany` from `mycompany.workable.com`).
|
|
33
|
+
4. In Orchesty, open the Workable application settings and enter both values.
|
|
34
|
+
|
|
35
|
+
### API Documentation
|
|
36
|
+
|
|
37
|
+
Workable API: [https://workable.readme.io/reference/](https://workable.readme.io/reference/)
|
|
38
|
+
|
|
39
|
+
## Installation & Usage
|
|
40
|
+
|
|
41
|
+
Install the package:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install @orchesty/connector-workable @orchesty/nodejs-sdk
|
|
45
|
+
# or
|
|
46
|
+
pnpm add @orchesty/connector-workable @orchesty/nodejs-sdk
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Register the application and nodes in your Orchesty DI container:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
53
|
+
import WorkableApplication from '@orchesty/connector-workable/dist/WorkableApplication';
|
|
54
|
+
import WorkableGetAccountsBatch from '@orchesty/connector-workable/dist/Batch/WorkableGetAccountsBatch';
|
|
55
|
+
import WorkableJobsBatch from '@orchesty/connector-workable/dist/Batch/WorkableJobsBatch';
|
|
56
|
+
|
|
57
|
+
const app = new WorkableApplication();
|
|
58
|
+
container.setApplication(app);
|
|
59
|
+
container.setNode(new WorkableGetAccountsBatch(), app);
|
|
60
|
+
container.setNode(new WorkableJobsBatch(), app);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
66
|
+
|
|
67
|
+
## Contributing
|
|
68
|
+
|
|
69
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
70
|
+
|
|
71
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
72
|
+
|
|
73
|
+
All contributions should include:
|
|
74
|
+
- Source code in `src/` following the existing connector structure
|
|
75
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
76
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-workable",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-workable",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
15
18
|
},
|
|
16
19
|
"engines": {
|
|
17
20
|
"node": ">=24"
|