Webhooks

Subscribe an https endpoint to events. Returns the signing secret once.

post/webhooks

Request

  • Base URL: https://api.relmcrm.com/v1
  • URL: https://api.relmcrm.com/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.relmcrm.com/oauth/authorize, token URL https://api.relmcrm.com/oauth/token, scopes: crm)

Request body

urlstring uri required

Public https endpoint (test mode allows localhost).

eventsstring[]

Subset of the 5 events, or ["*"].

descriptionstring
enabledboolean

Response

Created (secret shown once)

idstring
object'webhook'
urlstring
eventsstring[]
descriptionstring nullable
enabledboolean
secretstring

whsec_...; returned ONLY on create.

versioninteger

Example response

{
  "id": "wh_..."
}

Changes

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