Event trigger payload¶

HTTP request method¶

Delivered over HTTP POST with the following headers:

Content-Type: application/json

JSON payload¶

{
  "event": {
      "session_variables": <session-variables>,
      "op": "<op-name>",
      "data": {
          "old": <column-values>,
          "new": <column-values>
      }
  },
  "created_at": "<timestamp>",
  "id": "<uuid>",
  "trigger": {
      "name": "<name-of-trigger>"
  },
  "table":  {
      "schema": "<schema-name>",
      "name": "<table-name>"
  }
}

In case of:

• INSERT
  • event.data.old will be null
  • event.data.new will contain the insert row
• UPDATE
  • event.data.old will be values before the update
  • event.data.new will contain the values after the update
• DELETE
  • event.data.old will contain the row that is deleted
  • event.data.new will be null
• MANUAL
  • event.data.old will be null
  • event.data.new will contain the current row

For example:

{
  "id": "85558393-c75d-4d2f-9c15-e80591b83894",
  "created_at": "2018-09-05T07:14:21.601701Z",
  "trigger": {
      "name": "test_trigger"
  },
  "table": {
      "schema": "public",
      "name": "users"
  },
  "event": {
      "session_variables": {
          "x-hasura-role": "admin",
          "x-hasura-allowed-roles": "['user', 'boo', 'admin']",
          "x-hasura-user-id": "1"
      },
      "op": "INSERT",
      "data": {
        "old": null,
        "new": {
            "id":"42",
            "name": "john doe"
        }
      }
  }
}

Syntax definitions¶

{
  "column1": "value1",
  "column2": "value2",
  ..
}

"INSERT" | "UPDATE" | "DELETE" | "MANUAL"

Webhook response structure¶

A 2xx response status code is deemed to be a successful invocation of the webhook. Any other response status will be deemed as an unsuccessful invocation which will cause retries as per the retry configuration.

It is also recommended that you return a JSON object in your webhook response.