A service for interacting with help desks such as Zendesk and Halo ITSM.
The service provides an API that should be used for ticket management and creation.
- Set up pre-commit as per https://github.com/uktrade/pii-secret-check-hooks
- Copy the example env file
cp .env.example .env
- Build local docker instance:
make build
make migrate
ormake first-use
- Start the local docker instance:
make up
ormake up-detached
to start in detached mode - The service will be available at:
http://localhost:8000/
make all-requirements
make createcachetable
- Environment Variables
- Connecting the project to Zendesk
- Defining the mapping from Zendesk custom fields to Halo
config/
- Django settings and top-level project confighelp_desk_api/
- API for help desk ticket managementemail_router
- Code for Lambda function to post received emails as ticketsses_email_receiving
- Lambda function codeutils/build_layer.py
- Utility to package a Lambda layer based onlambda_layer_requirements.txt