Passing the Patchworks signature as a header for callback requests

Introduction

When a callback is generated via the trigger shape, it includes a Patchworks signature - by default, this is defined as a URL parameter. However, some third-party systems do not accept URL parameters.

In this case, the signature element should be removed from generated URLs and passed as a patchworks-signature request header instead.

The steps

1

Generate a callback trigger

Access the trigger shape and add a callback (or use an existing callback).

2

Copy the callback URL

Copy the callback URL, then paste it into your preferred editor. It will look something like this:

https://callbacks.wearepatchworks.com/api/v1/docsdemo/01jvgtcr9gr66t84wh2fg9kse37?patchworks_signature=fr80fg6e2g94jj908f1698htggrswgw6319ns6r194fh2nkekcht

3

Save the Patchworks signature value from the callback URL

Copy the signature value and paste it somewhere accessible - you'll need this value shortly. For example:

fr80fg6e2g94jj908f1698htggrswgw6319ns6r194fh2nkekcht

4

Edit the callback URL

Remove the entire URL parameter section of the URL (i.e. remove the ?patchworks_signature element). The updated URL will look something like this:

https://callbacks.wearepatchworks.com/api/v1/docsdemo/01jvgtcr9gr66t84wh2fg9kse37

5

Apply the updated URL in your callback requests & add a signature header

Use the updated URL in your callback request AND add a patchworks-signature header. The value for this header will be the signature that you saved in step 3. For example:

The header must be patchworks-signature NOT patchworks_signature .