taler-docs

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

get-private-webhooks.rst (1149B)

      1 .. http:get:: [/instances/$INSTANCE]/private/webhooks
      2 
      3   This is used to return all the webhooks that are present in our backend.
      4 
      5   **Required permission:** ``webhooks-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The backend has successfully returned all the webhooks. Returns a `WebhookSummaryResponse`.
     11 
     12   :http:statuscode:`401 Unauthorized`:
     13     The request is unauthorized.
     14   :http:statuscode:`404 Not found`:
     15     The backend has does not know about the instance.
     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:: WebhookSummaryResponse
     23 
     24     interface WebhookSummaryResponse {
     25 
     26       // Return webhooks that are present in our backend.
     27       webhooks: WebhookEntry[];
     28 
     29    }
     30 
     31   The `WebhookEntry` object describes a webhook. It has the following structure:
     32 
     33   .. ts:def:: WebhookEntry
     34 
     35     interface WebhookEntry {
     36 
     37       // Webhook identifier, as found in the webhook.
     38       webhook_id: string;
     39 
     40       // The event of the webhook: why the webhook is used.
     41       event_type: WebhookEventType;
     42 
     43    }