GuildQualityIntegration

Webhooks

Use incoming webhooks to get real-time updates

GuildQuality uses webhooks to notify your application when an event happens in your account.  A webhook enables GuildQuality to push real-time data to your app. We use HTTPS to send this data to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems.

Survey Completion Webhook

When a Survey Completion webhook is created in your account, GuildQuality will push survey data (questions, answers, contact data and project data) to the webhook payload URL you define when a survey is completed.

You can start receiving survey completion notifications in your app using these steps:

  1. On your local server, create a webhook endpoint as a HTTP endpoint (URL).
  2. In the GuildQuality app, go to Account->Webhooks and click “Create new webhook”.
  3. Enter the Payload URL.  This is the URL you created on your server that will accept the completed survey data.
  4. Set the Webhook Type to Survey Completion.
  5. If you would like the call to your server to be authenticated by a bearer token, enter the secret into the Secret field.
  6. Turn the webhook On.
  7. Save the webhook.
Now, anytime a survey is completed, a JSON payload will be sent to the Payload URL. An example of how the survey json data will be formatted can be found here, https://documenter.getpostman.com/view/2124402/TVRecqCj#0a635e4b-d0c0-4840-a313-6d48fbeb2a3b.

Comment Published Webhook

When a comment on a survey is published to your GuildQuality company profile, GuildQuality will push data belonging to that survey (questions, answers, contact data, and project data) to the webhook payload URL you define.

You can start receiving comment published notifications in your app using these steps:

  1. On your local server, create a webhook endpoint as a HTTP endpoint (URL).
  2. In the GuildQuality app, go to Account->Webhooks and click “Create new webhook”.
  3. Enter the Payload URL.  This is the URL you created on your server that will accept the survey data when a comment is published.
  4. Set the Webhook Type to Comment Published.
  5. If you would like the call to your server to be authenticated by a bearer token, enter the secret into the Secret field.
  6. Turn the webhook On.
  7. Save the webhook.
Now, anytime a comment on your completed survey is published, a JSON payload will be sent to the Payload URL. An example of how the survey json data will be formatted can be found here, https://documenter.getpostman.com/view/2124402/TVRecqCj#0a635e4b-d0c0-4840-a313-6d48fbeb2a3b.