QWqwist
Notifications

Modify notification

Changed on

Update the properties of a notification.

put/rest/notifications/{notification-id}

Request

Parameters

#/paths/~1rest~1notifications~1{notification-id}/get/parameters/0 (unresolved $ref)
#/paths/~1auth~1user/post/parameters/0 (unresolved $ref)

Request body

notify_uristring url

Notification messages will be sent to this URL. The URL schemes https and http are used for webhooks.

statestring

An arbitrary string to maintain state between this request and the callback, e.g. it might contain a session ID from your application. The value should also contain a random component, which your application checks to prevent cross-site request forgery.

observe_keystring

Notification key

Example request

{
  "notify_uri": "https://finx.example.com/callback/A12345.6",
  "state": "4HgwtQP0jsjdz79h",
  "observe_key": "rest/notifications/test"
}

Response

(unresolved $ref)

Changes

  • 398592d93b1fRevision changes
    • breaking

      added the new path request parameter notification-id

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status