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

Endpoint responsible for list all webhooks url registered in EverReal.

Headers

Name	Type	Description
Authorization	string	Bearer Token

200

[
    {
        "id": "01dd383b-9106-4921-bb53-aasdfa3",
        "type": "LISTING_CREATED",
        "partnerId": "01dd383b-9106-4921-bb53-aasdfa3",
        "companyId": "01dd383b-9106-4921-bb53-aasdfa3",
        "connectedByUserId": "01dd383b-9106-4921-bb53-aasdfa3",
        "url": "https://collect2.com/api/01dd383b-9106-4921-bb53-aasdfa3/datarecord/",
        "createdAt": "2020-09-30T10:07:28.052Z",
        "updatedAt": "2020-09-30T10:07:28.052Z",
        "deletedAt": null
    }
]

403 User not authorized

{
    "code": "server_error",
    "statusCode": 403
}

Register a new Webhook

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

Webhook in EverReal server.

Headers

Name	Type	Description
Authorization	string	Bearer Token

Request Body

Name	Type	Description
Body Request	object	{ "type":"string", "url":"string" }

200

// Response Header
{
"Location": "d32d5912-4496-4398-814e-a734ccadb615"
}

Delete a Webhook

DELETE https://{subdomain}.everreal.co/api/external-integrations/webhooks/:id

Deletes a webhook by its unique ID.

Path Parameters

Name	Type	Description
:id	string	Webhook id provided by EverReal

Headers

Name	Type	Description
Authorization	string	Bearer Token

204

Event Types

Below is a list of all events available in EverReal.

Each event type has its own data structure used when notifying 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

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>"
}'