HireHop can send a message with data to other apps when certain events are triggered within HireHop.  This message is called a webhook which automatically pushes the relevant data to the required location.

What is a webhook?

A webhook sends/pushes a message, with data attached to the message, when specific things happen in HireHop (an event).  Webhooks are sent via HTTP (calls a web address) and are a way of pushing data to other applications in real-time.  Webhooks deliver the relevant data to specific applications as it happens, meaning the receiving application gets data immediately after the event happens, which is far more efficient and faster than polling for data changes..

HireHop webhooks can be used to communicate directly with other apps or be sent to a connector like Zapier, that can be made to format the data and make any necessary API calls back to HireHop or to another application.

Setting up a webhook

In HireHop, go to „Settings“ then click the „Company settings“ tab and the „Webhooks“ button at the top of the page.  In the popup window, click on the „New“ button and add the URL where the webhook message is to be sent to and select every webhook that you want the URL to respond to.  You can add as many webhooks as you want, but should limit them to only the necessary ones that the specific URL will respond to.

A HireHop webhook will POST data to your URL endpoint as JSON, and will contain the following or similar data.

{
    "time": "2022-03-29 07:50:42",
    "user_id": 1,
    "user_name": "John Smith",
    "user_email": "john@email.com",
    "company_id": 1,
    "export_key": "22u43mrjwe7u",
    "event": "invoice.status.updated",
    "data": { ... },
    "changes": {
        "FIELD_NAME": {
            "from": "old",
            "to": "new"
        }, ...
    }
}

In the above JSON example, the following fields are:

• „time“ is the UTC time and date the webhook was sent.
• „user_id“ is the ID of the user who caused the event to be triggered.
• „user_name“ is their user’s name.
• „company_id“ field is the unique number identifier of the company the user works for.
• „export_key“ is the value of the export key in company settings which can be used as a security check.
• „event“ is the name of the webhook event that was triggered.
• „data“ is the data that appertains to the webhook event.
• „changes“ are the fields that changed, being what they were to what they got changed to.

HireHop will not wait for a response from the called URL or report an HTTP error from calling it.

Example PHP code for a URL endpoint to capture the webhook data would be:

<?php
	// Read the JSON data
	$postdata = file_get_contents('php://input');
	// Convert JSON data to an object
	$data_str = json_decode($postdata);
?>

HireHop je postavený na rozhraní API, čo znamená, že čokoľvek, čo HireHop robí, môžete vykonať aj pomocou rozsiahleho rozhrania API. Všetko, čo potrebujete na prístup k Rest API, je užívateľský token aplikovaný ako GET alebo POST na príslušný koncový bod URL.

API Tokeny

Ak chcete vygenerovať token API, prejdite na stránku „Nastavenia“ a vyberte kartu „Používatelia“. Vyberte alebo vytvorte používateľa a potom, keď je vybraný konkrétny používateľ, kliknite na tlačidlo „Ponuka“ a potom na možnosť „Token API“ a vygenerujte token. Token sa potom zobrazí a možno ho skopírovať do schránky pomocou tlačidla kopírovať.

Token sa stane neplatným, ak zmeníte e-mail alebo heslo vybraného používateľa alebo sa k nemu následne prihlásite. Aby ste tomu zabránili, mali by ste vytvoriť špecializovaného používateľa rozhrania API a z bezpečnostných dôvodov mu poskytnúť príslušné povolenia, čím ho obmedzíte na čokoľvek, na čo nebudete rozhranie API používať.

Z bezpečnostných dôvodov by ste nikdy nemali používať token v kóde JavaScript front-end, mali by ste ho použiť iba na strane servera, pretože ak hacker získa token, môže zmeniť a získať prístup k vašim údajom na HireHop, takže svoj token udržujte v tajnosti. Ak váš token unikne, stačí zmeniť heslo používateľa API a vygenerovať nový token.

Použitie Tokenu

Token by mal byť nastavený ako parameter GET alebo POST, ktorý sa nazýva „token“. Napríklad na načítanie údajov úlohy pre úlohu číslo 52 HireHop zavolá koncový bod API:

https://myhirehop.com/php_functions/job_refresh.php?job=52

Ak chcete volať rovnaký koncový bod pomocou tokenu, adresa URL by bola:

https://myhirehop.com/php_functions/job_refresh.php?job=52&token=dqwejk5GVT65909bHHBN7922pq5hxjm%207hmn

Pamätajte, že pri odovzdávaní tokenu cez GET (parameter adresy URL, ako je uvedené vyššie), musíte token najskôr zakódovať pomocou nástroja, ako je https://meyerweb.com/eric/tools/dencoder.

Údaje zaúčtovania

Ak chcete vytvoriť alebo upraviť údaje v HireHop , musíte použiť POST. Pri odosielaní údajov by ste mali nastaviť iba polia, ktoré chcete zmeniť, napríklad vytvoriť alebo upraviť úlohu pomocou koncového bodu https://myhirehop.com/php_functions/job_save.php, pričom parameter „job“ nastavte na „0 “ alebo jeho vynechaním vytvoríte novú úlohu, čokoľvek iné upraví príslušné číslo úlohy. Ak chcete upraviť názov spoločnosti v úlohe číslo 52, údaje o príspevku by mali byť:

{
"job" : 52,
"name" : "New Name",
"token" : "dqwejk5GVT65909bHHBN7922pq5hxjm=-7hmn"
}

Koncové body API

Mnohé koncové body API sú zdokumentované v dokumentácii API a mnohé ďalšie treba nasledovať.  Ak chcete vytvoriť koncový bod pre úlohu, v aplikácii HireHop použite sieťovú konzolu prehliadača na kontrolu sieťových volaní a nastavení parametrov. Čoskoro bude zverejnený rozsiahly sprievodca koncovými bodmi URL.

Obmedzenia sadzieb

HireHop umožňuje každému používateľovi 60 žiadostí o pripojenie v priebehu 1 minúty. Ak ich je viac ako 60, vráti sa chyba „Bezpečnostné varovanie, príliš veľa transakcií“ (327).