---
updatedAt: 2025-11-13T23:12:41.000Z
---

# Subscribe

**webhooks** enables you to get updates on changes, without the need to poll the Gett business API.

## What's a webhook?

A webhook is an endpoint that you set up on a publicly accessible server you control. After registering that endpoint with Gett, Gett will then make HTTP POST requests to it when certain events occur. The POST body will be sent as JSON, in the following format:

> 📘
>
> Subscribing to webhooks allows you to track changes in the reports in real-time.

## Request

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>

      </th>

      <th>

      </th>

      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Resource url
      </td>

      <td>
        [https://business-api.gett.com/v1/subscribers?businessId=](https://business-api.gett.com/v1/subscribers?businessId=)&lt;companyUUID&gt;
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        businessid
      </td>

      <td>
        string
      </td>

      <td>
        Company UUID identificator obtained from Gett in registration process
      </td>
    </tr>

    <tr>
      <td>
        event\_types
      </td>

      <td>
        string
      </td>

      <td>
        from\_list\
        "status\_changed"\
        "business\_report"
      </td>
    </tr>

    <tr>
      <td>
        hook\_address
      </td>

      <td>
        string
      </td>

      <td>
        valid url of endpoint to receive updates.
      </td>
    </tr>
  </tbody>
</Table>

```curl
curl --request POST \
  --url 'https://business-api.gett.com/v1/subscribers?businessId=[company_uuid]' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{"hook_address":"https://host/endpoint","event_types":"business_report"}'
```

## Response

| Name                          | Type   | Desc.                                                                     |
| :---------------------------- | :----- | :------------------------------------------------------------------------ |
| id                            | string | subscriber id.                                                            |
| hook\_address                 | string | valid url of endpoint to receive updates.                                 |
| event\_types                  | object | list of event types in hook                                               |
| event\_types\[].event\_type   | string | event type                                                                |
| business\_ids                 | object | list of business id's                                                     |
| business\_ids\[].business\_id | string | business id relevant to event                                             |
| secret\_id                    | string | uuid verification token used to validate that request was sent from Gett. |
| created\_at                   | string | RFC 3339 date. states when subscription has been created.                 |
| updated\_at                   | string | RFC 3339 date. states when subscription has been updated.                 |

```json
{
    "id": "e3982=-b3d798e89fcb",
    "hook_address": "https://host/endpoint",
    "event_types": [
        {
            "event_type": "business_report"
        }
    ],
    "business_ids": [
        {
            "business_id": "6AA6CF-gegege-fgfgf-ghghg06"
        }
    ],
    "secret_id": "bf53-b973-0fd890f2b39c",
    "created_at": "2021-05-09T16:33:48.518547841Z",
    "updated_at": "2021-05-09T16:33:48.518547841Z"
}
```

<Callout icon="🔒" theme="default">
  ### **Important**: The `secret_id` in the response is used to verify webhook authenticity. See [Webhook Verification](https://developer.gett.com/docs/webhooks-verification) for details on how to implement signature verification.
</Callout>

## Next Steps

* Learn about [webhook event types](https://developer.gett.com/docs/events) you can subscribe to
* Implement [webhook verification](https://developer.gett.com/docs/webhooks-verification) to secure your endpoint