graphql-engine/docs/graphql/manual/getting-started/first-event-trigger.rst

66 lines
1.8 KiB
ReStructuredText
Raw Normal View History

.. meta::
:description: Set up a first event trigger with Hasura
:keywords: hasura, docs, start, event trigger
.. _first_event_trigger:
Setting up your first event trigger
===================================
.. contents:: Table of contents
:backlinks: none
:depth: 1
:local:
You can use Hasura to setup event triggers that call configured webhooks whenever specific database events occur.
Let's create a sample event trigger with https://httpbin.org as our simple webhook.
Create a table
--------------
Head to the Hasura console, navigate to ``Data -> Create table`` and create a sample table called ``profile`` with
the following columns:
2019-02-06 09:39:36 +03:00
.. code-block:: sql
2019-02-06 09:39:36 +03:00
profile (
id INT PRIMARY KEY,
name TEXT
)
2020-05-05 06:52:08 +03:00
.. thumbnail:: /img/graphql/manual/getting-started/create-profile-table.png
:alt: Create a table
Setup an event trigger
----------------------
In the Hasura console, navigate to ``Events -> Create trigger`` and:
1. Enter trigger name as ``echo``.
2. Select table ``profile`` from the table dropdown.
3. Select operations: ``insert``, ``update`` and ``delete``.
4. Enter webhook URL as: ``https://httpbin.org/post``.
2020-05-05 06:52:08 +03:00
.. thumbnail:: /img/graphql/manual/getting-started/create-event-trigger.png
:alt: Set up an event trigger
This sets up our webhook ``https://httpbin.org/post`` to receive database changes on an insert, update and delete on
``profile`` table.
Watch the trigger in action
---------------------------
2019-02-06 09:39:36 +03:00
1. Insert some sample data into the ``profile`` table using the ``Insert Row`` tab.
2. Now navigate to the ``Events`` tab and click on the ``echo`` trigger in the left sidebar.
3. Expand the details of an event to see the response from the webhook.
2020-05-05 06:52:08 +03:00
.. thumbnail:: /img/graphql/manual/getting-started/trigger-events.png
:alt: Trigger in action
Next steps
----------
Read more about:
- :ref:`Event triggers <event_triggers>`