Setup Guide
Follow these steps to configure a webhook for your workspace:
Log in to UseStencil
Navigate to your Template that you wish to have integration with. This is located under the "Project" tab.
Click on the triple-dot menu to bring up the menu options for the template. Choose "Webhooks".
Click "Add Webhook".
Fill in the following fields:
Webhook name
A friendly name for your reference.
Webhook URL
The HTTPS endpoint where UseStencil should send the payload.
Custom headers (Optional)
Key-value pairs to be included as HTTP headers in the request. Useful for:
Authentication tokens (e.g.,
Authorization: Bearer YOUR_TOKEN
)Source-identification headers (e.g.,
X-Origin: stencil
)
Custom Body (Optional)
Define a custom JSON payload structure under the user_defined
field.
You can:
Include static values (e.g., "source": "usestencil")
Inject dynamic values using handlebars-style templating like:
{ "image_id": "{{data.id}}", "url": "{{data.url}}", "created_at": "{{timestamp}}" }
Click Save and that's it! Isn't that easy?
Using Custom Headers for Security
Custom headers are a simple yet powerful way to pass authentication tokens or shared secrets to your server. You can configure:
Authorization: Bearer abc123
X-Signature: custom-value
X-App-Key: my-service-key
These headers will be included in every webhook request and can be validated on your backend.
Managing Webhooks
From the Webhooks dashboard, you can:
Pause or edit existing webhooks
Delete unused ones
View recent delivery logs to inspect response codes, headers, and payloads.
✅ Next StepsNow that you’ve set up and tested your webhook with custom headers and payloads, you’re ready to explore the Payload Structure in detail
Last updated
Was this helpful?