Webhooks

Subscribe to an event

Start receiving an event for one portal. portalId is required — a connection covers several portals, so a subscription has to say which.

Re-subscribing the same URL for the same portal and event is idempotent, so a retried call does not double-deliver. The same URL for a different portal is a separate subscription, which is how one integration listens to several portals.

targetUrl must be a public HTTPS URL. Anything resolving to a loopback, private, link-local or CGNAT address is refused, here and again at delivery.

post/api/v1.1/webhooks

Request

  • Base URL: https://app.formaportal.com
  • URL: https://app.formaportal.com/api/v1.1/webhooks
  • Auth: OAuth 2 (authorization code, authorization URL https://app.formaportal.com/oauth/authorize, token URL https://app.formaportal.com/api/oauth/token, scopes: webhooks:write)

Request body

portalIdstring required

A portal from GET /api/v1.1/portals.

event'form_submission' | 'contact_registered' required
targetUrlstring uri required

Where to POST the event. hookUrl and target_url are accepted as aliases.

Example request

{
  "portalId": "portal1234"
}

Response

The subscription.

idstring required
portalIdstring

The portal this subscription listens to. Absent on v1, which had only one.

event'form_submission' | 'contact_registered' required
targetUrlstring uri required

Example response

{
  "id": "g1qzf3mp1m",
  "portalId": "portal1234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.