NEneotimo
Neotimo/Webhooks

Creates a webhook subscription.

Changed on

Returns the cleartext signing secret one time — store it. Later GETs expose only the 6-char prefix. The URL must be HTTPS on the default port 443; raw IP literals are refused and the resolved address is re-checked at connect time against the SSRF deny-list.

post/api/v1/neotimo/webhooks/subscriptions

Request

  • Base URL
    https://api.neotimo.com
  • Auth
    HTTP bearer and API key in header X-Api-Key

Request body

namestring nullable

Caller-supplied label, surfaced in the partner dashboard. Optional: the partner API documents a subscription as {url, events}, so a missing name gets a default rather than a 422 on a field the caller never heard of.

urlstring required

HTTPS endpoint that receives the signed payload.

eventsstring[] required

Event names to subscribe to, e.g. ["invoice.delivered", "invoice.timeline.changed"].

activeboolean

Whether the subscription is delivering events. Default true.

Response

Created

Changes

  • d134f2cbfaf5Revision changes
    • breaking

      the request property type changed from string to array (media type: application/json-patch+json)

    • breaking

      the request property type changed from string to array (media type: application/json)

    • breaking

      the request property type changed from string to array (media type: text/json)

    • breaking

      the request property type changed from string to array (media type: application/*+json)

    • breaking

      the // response's property type changed from string to array for status (media type: application/json)

    • info

      the request property became nullable (media type: application/json-patch+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became optional (media type: application/json-patch+json)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: text/json)

    • info

      the request property became optional (media type: application/*+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: text/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/*+json)