Webhooks (v1, deprecated)

Subscribe to an event

Registers a URL to receive an event. Re-subscribing the same URL for the same event is idempotent and returns the existing subscription.

The target must be a public HTTPS URL. Anything resolving to a loopback, private, link-local or carrier-NAT address is rejected, credentials in the URL are rejected, and redirects are never followed.

post/api/v1/webhooks

Request

  • Base URL: https://app.formaportal.com
  • URL: https://app.formaportal.com/api/v1/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

event'form_submission' | 'contact_registered' required
hookUrlstring uri required

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

Response

Subscribed.

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.