Webhooks

Subscribe a URL to signing events

Delivers the chosen events of every signing this integration creates to url (the subscriptionEvent webhook below). This is what Zapier, Make and Power Automate call when a user turns a trigger on. The same URL again replaces its event list and returns the same subscription, so a retried subscribe never doubles deliveries. url is checked like webhookUrl: public HTTPS, at most 500 characters, redirects never followed. An integration holds at most 50 subscriptions (v1.12.0).

post/v1/webhooks

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://sign-api.tvarka.pro/oauth/authorize, token URL https://sign-api.tvarka.pro/oauth/token, scopes: sign.read, sign.signings)

Request body

urlstring uri required
eventsWebhookEventName[] required

Response

Subscribed.

webhookIdstring uuid required
urlstring uri required
eventsWebhookEventName[] required
createdAtstring date-time required

Changes

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