Webhook Authentication

Check your webhook credentials

post
/webhook/check
https://api.hrflow.ai/v1/webhook/check 
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
Body Parameters
url
optional
string
Webhook callback url.
type
optional
string
Webhook type.
Response
200: OK
Webhook successfully checked.
{
    "code": 200,
    "message": "ok",
    "data": {
        "team_name": "stark",
        "webhook_id": "wid_6637839405e8b44e75b38e",
        "url": "https://webhook.site/79f29230-9346-44e9-997f-035365443a64",
        "type": "profile.parsing.success"
    }
}
401: Unauthorized
Invalid secret token.
{
    "code": 401,
    "message": "Unauthorized. Invalid secret key: xxxxx "
}
Example
PHP
Python
PHP
require_once('vendor/autoload.php');
​
$client = new Hrflow\Client('your secret key');
​
$data = [
    'url'  => 'webhook url',
    'type' => 'profile.parsing.success'
];
​
$client->webhooks->check($data) ;
Python
  client.webhooks.check()

API Reference - Previous

Webhooks

Webhook Configuration

Last updated 1 year ago

Webhook Authentication

post/webhook/check

Example

post
/webhook/check