https://github.com/gcaccaos/dialogflow-fulfillment
Create fulfillment webhooks for Dialogflow using Python.
https://github.com/gcaccaos/dialogflow-fulfillment
agent api client dialogflow fulfillment python webhook
Last synced: 7 months ago
JSON representation
Create fulfillment webhooks for Dialogflow using Python.
- Host: GitHub
- URL: https://github.com/gcaccaos/dialogflow-fulfillment
- Owner: gcaccaos
- License: apache-2.0
- Archived: true
- Created: 2020-03-13T23:52:24.000Z (over 6 years ago)
- Default Branch: development
- Last Pushed: 2023-06-12T21:01:54.000Z (about 3 years ago)
- Last Synced: 2025-09-25T07:17:55.489Z (11 months ago)
- Topics: agent, api, client, dialogflow, fulfillment, python, webhook
- Language: Python
- Homepage: https://dialogflow-fulfillment.readthedocs.io
- Size: 317 KB
- Stars: 15
- Watchers: 2
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dialogflow-fulfillment
[](https://pepy.tech/project/dialogflow-fulfillment)
[](https://github.com/gcaccaos/dialogflow-fulfillment/actions)
[](https://dialogflow-fulfillment.readthedocs.io/en/latest/?badge=latest)
[](https://codeclimate.com/github/gcaccaos/dialogflow-fulfillment/maintainability)
[](https://github.com/gcaccaos/dialogflow-fulfillment/blob/main/LICENSE)
*dialogflow-fulfillment* is a package for Python that helps developers to
create webhook services for Dialogflow.
The package provides an API for creating and manipulating response messages,
output contexts and follow-up events in conversations.
## A simple example
```python
from dialogflow_fulfillment import QuickReplies, WebhookClient
# Define a custom handler function
def handler(agent: WebhookClient) -> None:
"""
This handler sends a text message along with a quick replies message
back to Dialogflow, which uses the messages to build the final response
to the user.
"""
agent.add('How are you feeling today?')
agent.add(QuickReplies(quick_replies=['Happy :)', 'Sad :(']))
# Create an instance of the WebhookClient
agent = WebhookClient(request)
# Handle the request using the handler function
agent.handle_request(handler)
# Get the response
response = agent.response
```
## Installation
The preferred way to install *dialogflow-fulfillment* is from
[PyPI](https://pypi.org/project/dialogflow-fulfillment/) with
[**pip**](https://pip.pypa.io/):
```shell
pip install dialogflow-fulfillment
```
## Features
*dialogflow-fulfillment*'s key features are:
* **Webhook Client**: handle webhook requests using a custom handler function
or a map of handlers for each intent
* **Contexts**: process input contexts and add, set or delete output contexts
* **Events**: trigger follow-up events with optional parameters
* **Rich Responses**: create and send the following types of rich response
messages:
* Text
* Image
* Card
* Quick Replies
* Payload
## More examples
* [Dialogflow fulfillment webhook server with **Flask**](https://dialogflow-fulfillment.readthedocs.io/en/latest/getting-started/examples/flask/)
* [Dialogflow fulfillment webhook server with **Django**](https://dialogflow-fulfillment.readthedocs.io/en/latest/getting-started/examples/django/)
## Documentation
For more information about the package, guides and examples of usage, see the
[documentation](https://dialogflow-fulfillment.readthedocs.io).
## Contribute
All kinds of contributions are welcome!
For an overview about how to contribute to *dialogflow-fulfillment*, see the
[contributing guide](CONTRIBUTING.rst).
## License
This project is licensed under the Apache 2.0 license.
For more details about the license, see the [LICENSE file](LICENSE).
## Acknowledgments
Thanks to the Dialogflow development team!