> For the complete documentation index, see [llms.txt](https://docs.pptxbuilder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pptxbuilder.com/v1/guide/webhook.md).

# Webhook

This page describes how to setup your web hook.

If you need to receive the latest changes from a project, you can tap into the `save` and `download` actions from a project. This means that whenever a user saves or downloads a project we will send you the latest updates through the configured `webhook`.

### How to setup a Webhook:

1. Navigate to the [Webhook Settings](https://api.pptxbuilder.com/api/webhook) section.
2. Add the `Webhook URL.`

{% hint style="warning" %}
You need to be registered and have created a company.
{% endhint %}

Once  you save the `webhook URL` you can test the connection to your `webhook` by ticking the *Validate Webhook?* `checkbox` . This will send a `POST` request to your `Webhook URL` and we will expect a `200` status response back.&#x20;

Check bellow for the details of the `POST` request we will perform.

{% hint style="info" %}
The Test Webhook request is performed by PPTX Builder API when you add a `webhook URL`
{% endhint %}

## Test Webhook

<mark style="color:green;">`POST`</mark> `<your_webhook_url>/`

This endpoint is used to confirm the connection between PPTX Builder and your endpoint&#x20;

#### Headers

| Name          | Type   | Description     |
| ------------- | ------ | --------------- |
| Authorization | string | Bearer \<token> |

#### Request Body

| Name        | Type    | Description         |
| ----------- | ------- | ------------------- |
| webhookTest | boolean | true                |
| key         | string  | \<your-company-key> |

{% tabs %}
{% tab title="200 Webhook is valid and active." %}

```
```

{% endtab %}
{% endtabs %}

## Webhook for saved/download data

<mark style="color:green;">`POST`</mark> `<your_webhook_url>/`

This endpoint is used to send the updated details.

#### Headers

| Name          | Type   | Description     |
| ------------- | ------ | --------------- |
| Authorization | string | Bearer \<token> |

#### Request Body

| Name           | Type    | Description     |
| -------------- | ------- | --------------- |
| base\_settings | object  | Project details |
| webhookTest    | boolean | false           |
| body           | object  | Project data    |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}
