Webhooks allow third party systems to be notified when certain events happen on the Elucidat system. This is achieved by third parties subscribing to pre-defined events via the following methods.
The callback is a POST request. Its headers will contain the public key used to subscribe to the webhook.
'List Subscriptions' returns the events subscribed to along with their callback urls as a key value array ('event' => 'callback_url').
Before using this call, you'll need to authenticate against the API as detailed in Making your first call to the Project API.
All of these examples have simulation mode turned on. Once you are ready to use in a production environment, you can remove the simulation parameter. Any changes will then affect your account.
PHP
$nonce = get_nonce('https://api.elucidat.com/v2/event', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'GET', 'https://api.elucidat.com/v2/event', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);Python 3.9
endpoint = '/v2/event'
method = 'GET'
params = {'simulation_mode': 'simulation'}
data = {}
api = Api(api_root, endpoint, method, params, data, private_key, public_key)
api.call_elucidat()Response
{
"release_course": "https://httpreq.com/delicate-field-yipak94o/record"
}