Subscribe an HTTPS endpoint; the signing secret is returned only once.

post/v1/webhook_endpoints

Request

  • Base URL: https://paperagent.dev
  • URL: https://paperagent.dev/v1/webhook_endpoints
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://paperagent.dev/oauth/authorize, token URL https://paperagent.dev/oauth/token, scopes: letters:write)
    • API key in header X-Api-Key
    • HTTP bearer

Request body

urlstring required
eventsstring[] required

Response

Success

idstring required
urlstring required
eventsstring[] required
activeboolean required
livemodeboolean required
disabled_reasonstring nullable required
consecutive_failuresnumber required
created_atstring required
secretstring required

Changes

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