Skip to main content

Register an integration

POST 
/ingest/sources

Registers a producer (a partner product, an HRMS, anything that emits the documented event envelope) and returns two things you need once and cannot read again:

  • data.source_id — the src_… id that appears in the ingest URL and binds an app credential to this integration.
  • data.secret.secret — the HMAC key that signs inbound events.

allowed_event_types is deny-by-default. Leave it empty and every inbound event is answered 200 {"ignored": true} and does nothing. Set the types (or wildcards) you will send.

Optional ip_allowlist applies to BOTH channels — inbound events and the REST credential minted against this integration.

Request​

Responses​

Registered — source_id and the one-time signing secret.