---
title: Requisition JSON Integration
slug: requisition-json-integration
docTags: 
createdAt: 2025-01-17T13:07:48.276Z
---

Generic JSON Payload requisitions integration. The role of this integration is to expose a Jobylon endpoint where the integrating partner can send requisitions as JSON data as well as receiving requisition status updates back to the integrating partner using optionally provided callback url.

## Authentication

Jobylon supports both OAuth 2.0 Client Credentials Flow (defined in [OAuth 2.0 RFC 6749, section 4.4](https://tools.ietf.org/html/rfc6749#section-4.4)) and Basic Authentication. 

Depending on the selected authentication method, Jobylon will either provide `client_id` and `client_secret` for OAuth or username and password for Basic Authentication headers.

## API specification

Once enabled, Jobylon will provide integration partner with a unique endpoint following such format:

`https://api.jobylon.com/requisitions/g/<id>/<uuid>/json-provider/`

Where `<id>` and `<uuid>` are supplied by Jobylon during the configuration process.

If the integration partner has provided Jobylon with a callback URL - Jobylon will call that URL on requisition status changes. 

If chosen, the callback request may include basic authentication headers, so integration partners could authenticate the request.

### Requisition creation

Integration partner is expected to perform `POST` requests with a JSON list of objects to Jobylon endpoint for requisition creation.

Any values of received data can later be configured to be displayed or used in Jobylon, however there are certain expected parameters:

| **Parameter name&#xA0;** | **Description**                                                                                                                                                                                              | **Required** |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ |
| jbl\_reference           | Company identifier where requisition belongs to. <br />It is especially useful when an organization has multiple accounts and would like to choose what account in Jobylon the posted requisition belongs to | Yes          |
| jbl\_external\_id        | Identifier of a requisition coming from external system                                                                                                                                                      | Yes          |
| jbl\_status              | Requisition status. Acceptable values are:<br />available, draft, scheduled, published, closed, archived                                                                                                     | Yes          |

### Requisition status updates

For requisition status updates, the integration partner should perform `PATCH` request with JSON objects to 

`https://api.jobylon.com/requisitions/g/<id>/<uuid>/json-provider/<external_id>/`

Where `external_id` url parameter must match `jbl_external_id` provided during requisition creation

## Environments

| **Domain**                   | **Purpose**                |
| ---------------------------- | -------------------------- |
| https\://staging.jobylon.com | Development and acceptance |
| https\://api.jobylon.com     | Production                 |