taler-docs

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

get-private-webhooks.rst (926B)

      1 .. http:get:: [/instances/$INSTANCES]/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:`404 Not found`:
     13     The backend has does not know about the instance.
     14 
     15   **Details:**
     16 
     17   .. ts:def:: WebhookSummaryResponse
     18 
     19     interface WebhookSummaryResponse {
     20 
     21       // Return webhooks that are present in our backend.
     22       webhooks: WebhookEntry[];
     23 
     24    }
     25 
     26   The `WebhookEntry` object describes a webhook. It has the following structure:
     27 
     28   .. ts:def:: WebhookEntry
     29 
     30     interface WebhookEntry {
     31 
     32       // Webhook identifier, as found in the webhook.
     33       webhook_id: string;
     34 
     35       // The event of the webhook: why the webhook is used.
     36       event_type: WebhookEventType;
     37 
     38    }