From dfee7a299cdbaa6f1159d20dc6bf2927f9c12c2d Mon Sep 17 00:00:00 2001 From: priscilla Date: Fri, 25 Nov 2022 07:14:23 -0500 Subject: update --- core/api-merchant.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'core') diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 0f8de0fa..55a4da06 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -3227,7 +3227,7 @@ Using template Webhooks -------- -The webhook is a backend feature that is used to send a sms to the merchant. This sms will confirm that the +The webhook is a backend feature that is used to send a confirmation to the merchant. It can be send with a SMS, email or with another method. It will confirm that the customer paid the merchant. It will show the date and the price the customer paid. @@ -3235,7 +3235,7 @@ customer paid the merchant. It will show the date and the price the customer pai Adding webhooks --------------- -.. http:post:: [/instances/$INSTANCES]/private/webhooks/$WEBHOOK_ID +.. http:post:: [/instances/$INSTANCES]/private/webhooks This is used to create a webhook. @@ -3265,7 +3265,7 @@ Adding webhooks url: string; // Method used by the webhook - methods: string; + http_method: string; // Header template of the webhook header_template?: string; @@ -3294,7 +3294,7 @@ Editing webhooks :http:statuscode:`404 Not found`: The webhook(ID) is unknown to the backend. :http:statuscode:`409 Conflict`: - The provided information is inconsistent with the current state of the template. Changes made is the same with another store. + The provided information is inconsistent with the current state of the webhook. Changes made is the same with another store. .. ts:def:: WebhookPatchDetails @@ -3307,7 +3307,7 @@ Editing webhooks url: string; // Method used by the webhook - methods: string; + http_method: string; // Header template of the webhook header_template?: string; @@ -3365,7 +3365,7 @@ Inspecting webhook **Response:** :http:statuscode:`200 OK`: - The backend has successfully returned the detailed information about a specific webhook. Returns a `Webhookdetails`. + The backend has successfully returned the detailed information about a specific webhook. Returns a `WebhookDetails`. :http:statuscode:`404 Not found`: The webhook(ID) is unknown to the backend. @@ -3382,7 +3382,7 @@ Inspecting webhook url: string; // Method used by the webhook - methods: string; + http_method: string; // Header template of the webhook header_template?: string; @@ -3393,7 +3393,7 @@ Inspecting webhook } -Removing template +Removing webhook ----------------- .. http:delete:: [/instances/$INSTANCES]/private/webhooks/$WEBHOOK_ID @@ -3403,7 +3403,7 @@ Removing template **Response:** :http:statuscode:`204 No content`: - The backend has successfully deleted the template. + The backend has successfully deleted the webhook. :http:statuscode:`404 Not found`: The webhook(ID) or the instance is unknown to the backend. -- cgit v1.2.3