taler-docs

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

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

      1 .. http:get:: [/instances/$INSTANCES]/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:`404 Not found`:
     13     The webhook(ID) is unknown to the backend.
     14 
     15   **Details:**
     16 
     17   .. ts:def:: WebhookDetails
     18 
     19     interface WebhookDetails {
     20 
     21       // The event of the webhook: why the webhook is used.
     22       event_type: WebhookEventType;
     23 
     24       // URL of the webhook where the customer will be redirected.
     25       url: string;
     26 
     27       // Method used by the webhook
     28       http_method: string;
     29 
     30       // Header template of the webhook
     31       header_template?: string;
     32 
     33       // Body template by the webhook
     34       body_template?: string;
     35 
     36    }