Trigger a webhook - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

Used to trig manualy a webhook. The user must be an admin.

URL : /albums/{album_id}/webhooks/{webhook_id}/trigger

Method : POST

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim.

Headers

  • Accept : If present, require that this value be application/json
  • Content-Type : Must be : application/x-www-form-urlencoded

Parameters

  • event={event}
    • if event is new_series
      • StudyInstanceUID={StudyInstanceUID}
      • SeriesInstanceUID={SeriesInstanceUID}
        • SeriesInstanceUID can be send multiple times.(Optional)
    • if event is new_user
      • user={user_id/user_mail}

Success Response

  • Status : 202 Accepted

Error Response

If the user is not found If the webhook is not found If the album is not found

  • Status : 404 Not Found

If a parameter is wrong

  • Status : 400 Bad Request