# Webhooks
To get notified of some communication or platform events, ApiRTC can trigger WebHooks to your backend server.
WebHooks are triggered asynchronously.
To handle WebHooks, your backend needs to accept HTTP requests. When some event occurs, ApiRTC makes a POST HTTP request to the URL you have configured for your WebHooks.
The request includes details of the event. Your backend can then perform whatever logic is necessary.
To be notified of events, the Apizee solution offers a webhook, a notification that is made through an HTTP request. This request transmits an "event" object to the server. Only media, conversations, and tickets benefit from this feature.
## Webhook Configuration
{% hint style="info" %}
Go to ApiRTC Console > Company > [Company account](https://cloud.apirtc.com/enterprise/edit) -> Settings -> WebHooks.
{% endhint %}
Webhooks configuration panel
* **Filter on event type**: Select the events which will trigger the webhook calls.
* **URL**: Set the URL which will be called by the webhook.
* **Custom headers**: In addition to filling in the URL field, you can add HTTP headers to the request (optional).
{% hint style="success" %}
Don't forget to check the **Activate** checkbox !
{% endhint %}
## Events
An event is sent (POST method) to the Webhook URL.
The request is equivalent to the CURL command below:
```bash
curl --request POST
-H "Content-Type: application/JSON"
--data '{"event":"update",...}'
https://my.domain.tld/apizeehooks/
```
### Default Header (header)
`User-Agent: Cloud Apizee`
### Events properties
The data sent is in JSON format and contains the following fields:
| Properties | Description | Value Type |
| ---------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `event` | Name of the event | "create", "update", "delete" |
| `time` | UNIX timestamp at the time of the event | integer |
| `object` | Name of the target object | "ticket", "media", "conversation", or "smsmessage" |
| `objectId` | Identifier of the target object | integer or uid depending on the object type |
| `props` | Properties of the target object. Depends on the target object (ticket, media, or conversation) | |
Example with a `ticket` object:
```json
{
"event": "update",
"time": 1575976413,
"object": "ticket",
"objectId": 100,
"props": {
"state": "invited"
}
}
```
Other example with a `conversation` object:
```json
{
"event": "update",
"time": 1632144306,
"object": "conversation",
"objectId": "734e3a7b-eb17-4d3f-901d-bcff178b",
"props": {
"eventType": "conversationEnded",
"name": "TEST",
"finishedAt": "2021-09-20T13:25:06+00:00"
}
}
```
### Properties per object type
#### Ticket
`object = ”ticket”`
| Name | Description | Values |
| ---------- | ----------------------- | ------------------------------------------------------------------------------------------ |
| state | Last recorded state | new, open, opened, invited, inprogress, updated, expired, declined, rejected, done, closed |
| geoloc.lat | Last recorded latitude | Example: 47.866675 |
| geoloc.lng | Last recorded longitude | Example: -3.865805 |
#### Media
`object = ”media”`
| Name | Description | Values |
| ------------- | ------------------------- | ----------------------------------------- |
| state | Last recorded state | inprogress, uncompleted, completed, error |
| \_parent.name | Name of the parent object | ticket, conference, conversation |
| \_parent.id | ID of the parent object | integer |
#### Conversation
`object = “conversation“`
Note: For this object, the `object_id` does not correspond to the database ID but to the `public_id` field in the database.
| Name | Description | Values |
| ---------- | ---------------------------- | -------------------------------------------- |
| eventType | Type of sent event | conversationEnded |
| name | Name of the conversation | string |
| finishedAt | End date of the conversation | string, Example: “2021-08-03T15:05:50+00:00” |
#### SMS
`object = "smsmessage"`
No property is attached to the events of this object.
#### Conversation\_event
`object = "conversationevent"`
| Field | Description | Value |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| eventType | Type of event (e.g., `media.OCRDone`, `ticket.new`) | string (see list at [Session Events API](/apirtc-developer-portal/rest-apis-and-integration/apizee-api-rest-description/session-events-api.md#event-model)) |
| eventCode | Digital code corresponding to the eventType. | integer |
| ticketId | ID of the ticket where the event occurred | integer |
| conversationId | ID of the conversation | integer |
| other fields... | depends on the event type. See[Session Events API](/apirtc-developer-portal/rest-apis-and-integration/apizee-api-rest-description/session-events-api.md#event-specific-data-field)for a list of event types. | |
{% hint style="info" %}
See [Session Events API](/apirtc-developer-portal/rest-apis-and-integration/apizee-api-rest-description/session-events-api.md) for more details on the event model.
{% endhint %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://dev.apirtc.com/apirtc-developer-portal/rest-apis-and-integration/webhooks.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.