taler-docs

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

patch-private-webhooks-WEBHOOK_ID.rst (1049B)

      1 .. http:patch:: [/instances/$INSTANCES]/private/webhooks/$WEBHOOK_ID
      2 
      3   This is used to update a webhook.
      4 
      5   **Required permission:** ``webhooks-write``
      6 
      7   **Request:**
      8 
      9   The request must be a `WebhookPatchDetails`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`204 No content`:
     14      The webhook has successfully modified.
     15   :http:statuscode:`404 Not found`:
     16      The webhook(ID) is unknown to the backend.
     17   :http:statuscode:`409 Conflict`:
     18      The provided information is inconsistent with the current state of the webhook. Changes made is the same with another store.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: WebhookPatchDetails
     23 
     24     interface WebhookPatchDetails {
     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    }