Versions Compared

Version Old Version 17 New Version 18
Changes made by

Volodymyr Machula

Volodymyr Machula

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Webhooks can be configured on the organization and event level.

Depending on whether one wants to use the default payload or a GraphQL-constructed payload for webhooks, there might be two different types of views for the structure. For constructing the webhook payload, please use values defined in https://gql.doo.net. For details on how to do that, use the steps defined in Constructing GraphQL body.

...

  1. Go to https://gql.doo.net

  2. Under the section HTTP Headers, put the Api_Key and Access Token in this format:

    Code Block
    {
  "x-api-key":"<api_key>",
 "Authorization":"Bearer <access_token>"
}


  3. Provide Query Variables. Example:

    Code Block
    {"id": <event_id>}


  4. Provide the body. Example:

    Code Block
    query EventShort($id: ID!){
  event(id: $id) {
    title,
    startDate,
    endDate
  }
}

    to construct a body, one can use the Schema (green button on the right). There you pick the desired entities and then use the detailed variables to construct the payload.

  5. Verify the payload. To do that, simply click on the Play button and you will get a complete payload in json and potentially discover mistakes in your body query.

  6. Once you are satisfied and want to create a webhook configuration with your GraphQL query, don't forget to escape the query before pasting it to the AddWebhook object.