taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-private-webhooks-WEBHOOK_ID.rst (1135B)

      1 .. http:get:: [/instances/$INSTANCE]/private/webhooks/$WEBHOOK_ID
      2 
      3   This is used to obtain detailed information about a specific webhook.
      4 
      5   **Required permission:** ``webhooks-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The backend has successfully returned the detailed information about a specific webhook. Returns a `WebhookDetails`.
     11 
     12   :http:statuscode:`401 Unauthorized`:
     13     The request is unauthorized.
     14   :http:statuscode:`404 Not found`:
     15     The webhook(ID) is unknown to the backend.
     16   :http:statuscode:`500 Internal Server Error`:
     17     The server experienced an internal failure.
     18     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: WebhookDetails
     23 
     24     interface WebhookDetails {
     25 
     26       // The event of the webhook: why the webhook is used.
     27       event_type: WebhookEventType;
     28 
     29       // URL of the webhook where the customer will be redirected.
     30       url: string;
     31 
     32       // Method used by the webhook
     33       http_method: string;
     34 
     35       // Header template of the webhook
     36       header_template?: string;
     37 
     38       // Body template by the webhook
     39       body_template?: string;
     40 
     41    }