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 section.

2. Add the Webhook URL.

You need to be registered and have created a company.

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.

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

The Test Webhook request is performed by PPTX Builder API when you add a webhook URL

Test Webhook

POST <your_webhook_url>/

This endpoint is used to confirm the connection between PPTX Builder and your endpoint

Headers

Name	Type	Description
Authorization	string	Bearer <token>

Request Body

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

200 Webhook is valid and active.

Webhook for saved/download data

POST <your_webhook_url>/

This endpoint is used to confirm the connection between PPTX Builder and your endpoint

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

200