Webhook

A webhook requirement asks the installer to register a webhook in a third-party tool or their own app so events are delivered to your service. The widget gives them the endpoint URL and any settings to enter.

When to use it

Use a webhook when your product needs to receive events from the installer's platform — order-created, form-submitted, deploy-finished, and so on. It's the right type whenever setup means "send your events here."

How to configure it

You define the details the installer must enter wherever they manage webhooks:

• Endpoint URL — the address events are sent to. Use a variable when it's per-installer (e.g. it includes their account ID).
• Events / triggers — which events to subscribe to.
• Secret — an optional signing secret, presented as a secret variable so it stays masked.

Add a webhook in your provider's dashboard:

  URL:    https://hooks.acme.com/{{accountId}}
  Events: order.created, order.updated

How it's verified

Webhooks are best verified with a custom check — your server confirms it received a valid delivery (often a test event) from the installer. If a public endpoint can report the subscription, an HTTP check works too. Otherwise use self-report.

Related

• Anatomy of an install template
• Variables
• Verification