Webhooks

Webhooks are user-defined HTTP callbacks. They are triggered by some event in a web application and can facilitate integrating different applications or third-party APIs, like Showwcase.

Showwcase uses webhooks to let your application know when events happen, such as receiving a thread reply or getting a comment on your show. When the event occurs, Showwcase makes an HTTP request (usually a POST or a GET) to the URL you configured for the webhook. Showwcase's request will include details of the event. Many other modern web services like GitHub and Slack also make use of webhooks to communicate events.

caution

You must deploy a publicly available endpoint that can handle the webhook payloads specified in this documentation. We support signing webhook payloads and using https (as well as http) for your webhook URLs

Webhooks are scoped only to the user that they're registered to. This means that when a webhook is registered, other users can't view, modify, or delete it.

Webhooks settings

info

Please note: webhook settings can be cached for up to five minutes. When making changes to the webhook URL, concurrency limits, or subscription settings, it may take up to five minutes to see your changes go into effect.

Post Create Webhook

Let's say you want to create a new webhook. You only need one thing to create a webhook: the webhook url.

posthttps://cache.showwcase.com/webhooks

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Body

Field	Type	Description
url	string	The URL to send the webhook to.
isActive	boolean	Whether the webhook is active or not.

get Get Webhook

gethttps://cache.showwcase.com/webhooks/:webhookId

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Parameters

Field	Type	Description
webhookId	string	The webhook unique id.

get Get Webhooks

gethttps://cache.showwcase.com/webhooks

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

PUT Update Webhook

You need to change your webhook URL — it happens! Here's how to do it:

puthttps://cache.showwcase.com/webhooks/:webhookId

Headers

Field	Description
Authorization	An access token that represents the user who wants to take an action. Read more about access tokens here.

Parameters

Field	Type	Description
webhookId	string	The webhook unique id.

Body

Field	Type	Description
url	string	The URL to send the webhook to.
isActive	boolean	Whether the webhook is active or not.

Delete Delete Webhook

deletehttps://cache.showwcase.com/webhooks/:webhookId

Headers

Field	Description
Authorization	An access token that represents the user who wants to take an action. Read more about access tokens here.

Parameters

Field	Type	Description
webhookId	string	The webhook unique id.