Webhooks
Webhooks are custom notifications where EverReal will send a request to registered url to notify a specific event happened in our system.

List Webhooks

get
https://{subdomain}.everreal.co/api/external-integrations
/webhooks
List webhooks

Register a new Webhook

post
https://{subdomain}.everreal.co/api/external-integrations
/webhooks
Register new Webhook

Delete new Webhook

delete
https://{subdomain}.everreal.co/api/external-integrations
/webhooks/:id
Delete webhook by id

Event Types

Bellow is all events available in EverReal.
Each Event Type contains its own data structure when notify the external system, on webhooks sub pages we provide details for each event type and data type.
Events
List of available actions
Listing events
LISTING_CREATED | LISTING_UPDATED | LISTING_ARCHIVED | LISTING_ACTIVATED | LISTING_DEACTIVATED | LISTING_PUBLISHED_TO_CHANNEL | LISTING_UNPUBLISHED_FROM_CHANNEL
Candidates events
CANDIDATE_PARSED | LISTING_CANDIDATE_APPLIED
Scheduling events
LISTING_CANDIDATE_SCHEDULE_INVITED_VIEWING | LISTING_CANDIDATE_SCHEDULE_NEW_TIMESLOTS_REQUESTED | LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_ADMIN | LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_CANDIDATE | LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_ADMIN | LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_CANDIDATE
Contracting events
LISTING_CONTRACT_FLOW_STARTED | LISTING_CONTRACT_FLOW_WITHDRAWN | LISTING_CONTRACT_FLOW_PARTIALLY_SIGNED | LISTING_CONTRACT_FLOW_SIGNED
Owner events
OWNER_CREATED | OWNER_UPDATED | OWNER_DELETED
Properties events
PROPERTY_CREATED | PROPERTY_UPDATED | PROPERTY_DELETED
Units events
UNIT_CREATED |UNIT_UPDATED |UNIT_DELETED
Protocol events
MOVE_IN_PROTOCOL_COMPLETED | MOVE_OUT_PROTOCOL_COMPLETED
Below we are providing a full example how to create webhook
cURL
curl --location --request POST 'https://acme-qa.everreal.co/api/external-integrations/webhooks' \
--header 'Authorization: Bearer eyJhbGciOiJ...' \
--header 'Content-Type: application/json' \
--data-raw '{
"type":"LISTING_CANDIDATE_APPLIED",
"url":"https://<your_domain>/<your_path>"
}'