This example demonstrates how to use Hookdeck with a Python Flask application to programmatically create a connection, publish events to it, and query those events.
-
Clone the repository:
git clone https://github.com/hookdeck/quickstarts.git
-
Navigate to the directory:
cd python/query -
Set up the environment:
Create a
.envfile by copying the example file:cp .env.example .env
You'll need to populate this file with your
HOOKDECK_API_KEY. -
Activate the virtual environment:
This project uses Poetry for dependency management. Activate the virtual environment with:
poetry shell
-
Install dependencies:
Once the shell is activated, install the dependencies with:
poetry install --no-root
When you first run the application, it will automatically create a new Hookdeck connection named python-query-example for you.
To run the Flask application, use the following command from within the Poetry shell:
python -m flask runThe application will be available at http://127.0.0.1:5000.
The application exposes the following endpoints:
/publish: A simple endpoint to generate and publish a sample event to your connection's source./events: An endpoint to query all events for the connection created by this application.
You can publish a sample event by sending a GET request to the /publish endpoint:
curl http://127.0.0.1:5000/publishYou can retrieve all events for the connection by sending a GET request to the /events endpoint:
curl http://127.0.0.1:5000/events