taler-docs

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

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

      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     Returned with ``TALER_EC_MERCHANT_GENERIC_WEBHOOK_UNKNOWN``.
     17   :http:statuscode:`500 Internal Server Error`:
     18     The server experienced an internal failure.
     19     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     20 
     21   **Details:**
     22 
     23   .. ts:def:: WebhookDetails
     24 
     25     interface WebhookDetails {
     26 
     27       // The event of the webhook: why the webhook is used.
     28       event_type: WebhookEventType;
     29 
     30       // URL of the webhook where the customer will be redirected.
     31       url: string;
     32 
     33       // Method used by the webhook
     34       http_method: string;
     35 
     36       // Header template of the webhook
     37       header_template?: string;
     38 
     39       // Body template by the webhook
     40       body_template?: string;
     41 
     42    }