https://github.com/workingconcept/lever-craft-plugin
Get Lever job details and post applications from Craft.
https://github.com/workingconcept/lever-craft-plugin
craft-plugin craft3 craftcms lever
Last synced: 6 months ago
JSON representation
Get Lever job details and post applications from Craft.
- Host: GitHub
- URL: https://github.com/workingconcept/lever-craft-plugin
- Owner: workingconcept
- License: mit
- Archived: true
- Created: 2018-12-12T22:33:51.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-10-12T20:33:49.000Z (over 3 years ago)
- Last Synced: 2025-06-14T03:40:26.720Z (about 1 year ago)
- Topics: craft-plugin, craft3, craftcms, lever
- Language: PHP
- Homepage:
- Size: 55.7 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
Lever Craft CMS 4 Plugin
Get Lever job details and post applications directly from Craft.
---
## Installation & Setup
- `composer require workingconcept/craft-lever`
- `php craft install lever` or install from _Settings_ → _Plugins_ in the control panel
- add your site and API details in the control panel via _Settings_ → _Lever_
## Development
### Templating
#### `craft.lever.jobs([])`
Returns an array of jobs. Supply valid parameters for the [job postings API](https://github.com/lever/postings-api) if you need to tailor the results.
#### `craft.lever.job(id)`
Returns a specific job matching the provided Lever ID, or `false`.
#### Job Properties
- `id`
- `text`
- `categories`
- `country`
- `description`
- `descriptionPlain`
- `lists`
- `additional`
- `additionalPlain`
- `hostedUrl`
- `applyUrl`
- `createdAt`
- `workplaceType`
### Template Examples
#### List Jobs
```twig
{% set positions = craft.lever.jobs %}
Work with Us!
- {{ position.text }}
{% for position in positions %}
{% endfor %}
```
#### Custom Job Application Form
You can create your own form and validation and submit it with an `action` field set to `lever/apply`. Use any fields named exactly as seen in the [postings API](https://github.com/lever/postings-api), with `jobId`, `name`, and `email` being required.
```twig
Apply
{% if application is defined and application.getErrors() | length %}
{% for field in application.getErrors() %}
{% for error in field %}
{{ error }}
{% endfor %}
{% endfor %}
{% endif %}
{{ csrfInput() }}
{{ redirectInput(craft.app.request.absoluteUrl ~ "?success=y") }}
{{ application.comments ?? '' }}
Submit
```
### Establishing Custom Job Detail Pages
You can display all job details on your site if you'd like, including custom detail pages. One way you might go about that is to create a detail page template like `jobs/_detail.twig` and set up a custom route for it.
Barebones template:
```twig
{% extends "_layout" %}
{% set job = craft.lever.job(id) %}
{% if job is empty %}
{% exit 404 %}
{% endif %}
{% block content %}
...
```
Custom route in `config/routes.php`:
```php
return [
'jobs/' => ['template' => 'jobs/_detail'],
];
```
This will take requests like `https://site.foo/jobs/be9f3647-b59a-4272-94a0-8b937520a69f` and send them to your template, where they'll 404 if the ID is invalid.
### Events
##### `EVENT_BEFORE_VALIDATE_APPLICATION`
Triggered after an application is submitted and before it's validated. You can adjust `$event->application` if you need to do something custom like handle a [FilePond](https://pqina.nl/filepond/) upload and attach it to the LeverJobApplication model.
##### `EVENT_BEFORE_SEND_APPLICATION`
Triggered after an application is submitted and before it's sent to Lever. Grab the application data from `$event->application` and prevent it from being sent by setting `$event->isSpam` to `true`.
##### `EVENT_AFTER_SEND_APPLICATION`
Triggered immediately after an application is sent to Lever successfully. Same `$event->application` and `$event->isSpam` properties available.
## Support
Please submit [an issue](https://github.com/workingconcept/lever-craft-plugin/issues) or [a pull request](https://github.com/workingconcept/lever-craft-plugin/pulls) if anything needs attention. We'll do our best to respond promptly.
---
This plugin is brought to you by [Working Concept](https://workingconcept.com), which has no affiliation with Lever.