Hooks API

NoteHistoryUpdates1

Notifies that one or more change history entries have been added in the Bubblehouse system.

MethodPOST
KindMutation Hook
URLThe webhook URL you specify, with :name replaced by NoteHistoryUpdates1
AuthenticationJWT HS256 Bearer token

This hook reports a span of updates, i.e. a set of consecutive changes. The updates are batched and delivered periodically.

Input

  • customer_idsarray of stringrequired

    Shop identifiers of the affected customers.

  • cursorbubbleflakerequired

    The cursor to retrieve changes in this span via ListHistoryX call.

Output

A successful response has no meaningful properties and only contains an ok property always set to true:

{"ok": true}

Specific Errors

StatusErrorReason & Examples

None.

API-wide Errors

StatusErrorReason & Examples

None.

Global Errors

StatusErrorReason & Examples

None.

Previous
NoteCustomerUpdates1