Webhook – SupportCandy https://supportcandy.net The most reliable customer support plugin and ticket system for WordPress Tue, 06 Feb 2024 05:57:25 +0000 en-US hourly 1 https://wordpress.org/?v=6.9.4 https://supportcandy.net/wp-content/uploads/2022/07/cropped-logo-32x32.png Webhook – SupportCandy https://supportcandy.net 32 32 General https://supportcandy.net/docs/web-hook/ Mon, 18 Dec 2023 09:39:32 +0000 https://supportcandy.net/?post_type=docs&p=333173

SupportCandy provides a powerful webhook feature that allows users to receive notifications and data updates for various actions within the system. Webhooks are outgoing requests sent to a specified URL whenever a trigger event occurs, such as creating a ticket, changing status, assigning tickets, closing tickets, or replying to tickets.

This documentation guides you through the process of setting up and managing webhooks in SupportCandy.

Creating a New Webhook
  1. In the SupportCandy settings, go to the “Webhooks” section.
  2. Click on “Add New”
  3. Fill in the required details, including the webhook name and the Delivery URL where the webhook requests will be sent.
  4. Choose the trigger events that will activate the webhook.
  5. Generate the secret for webhook.
  6. Submit the webhook configuration.
Webhook Settings
  • Webhook Name: A descriptive name for the webhook.
  • Delivery URL: The URL where webhook requests will be sent.
  • Triggers: Select trigger that will activate the webhook.
  • Secret Key: (Optional) Add a secret key for enhanced security.
How to authentic webhook response?

The secret key used to generate a hash of the delivered webhook and provided in the request headers.
The hash is received – as a HTTP header in the webhook response. “X-WPSC-Webhook-Signature – A base64 encoded HMAC-SHA256 hash of the payload”.

You can use following php code to generate a base64 encoded hash MAC on your receiving side to compare with the X-WPSC-Webhook-Signature value in the HTTP header in order to validate the message. If your encoded hash signature and the one in the HTTP header match then you are able to assume this is a valid response from your site.

$yourHashSig = base64_encode(hash_hmac(‘sha256’, $webhook_payload, wp_specialchars_decode( $secret, ENT_QUOTES ), true));

The secret used here is the same secret value set on the webhooks configuration page.

]]> Triggers and logs https://supportcandy.net/docs/triggers-and-logs/ Mon, 18 Dec 2023 10:01:54 +0000 https://supportcandy.net/?post_type=docs&p=333184

Available Triggers

Create Ticket

This trigger is activated when a new support ticket is created.

Change Status

This trigger is activated when the status of a support ticket is changed.

Change Assignee

This trigger is activated when the assignee of a support ticket is changed.

Close Ticket

This trigger is activated when a support ticket is closed.

Reply to Ticket

This trigger is activated when a reply is added to a support ticket.

Submit Private Note

This trigger is activated when an agent submits private in a ticket.

Change Ticket Subject

This trigger is activated when the subject of the support ticket gets changed.

Change Ticket Category

This trigger is activated when the category of the support ticket gets changed.

Change Ticket Priority

This trigger is activated when the priority of the support ticket gets changed.

Change Ticket fields

This trigger is activated when any custom field of the support ticket gets changed.

Change Agentonly Fields

This trigger is activated when the Agentonly of the support ticket gets changed.

Out of SLA

This trigger is activated when the SLA of the support ticket gets out of the given time interval

Webhook Logs

Viewing Logs

View detailed logs of webhook requests and responses in the SupportCandy plugin.

]]>