From 5a9ac214435d8712157825d381b2d7acdb5f790f Mon Sep 17 00:00:00 2001 From: Catalin Pit <25515812+catalinpit@users.noreply.github.com> Date: Fri, 26 Apr 2024 10:25:16 +0300 Subject: [PATCH] chore: content updates --- apps/documentation/pages/public-api/intro.mdx | 15 ++++++++++++++- apps/documentation/pages/webhooks/intro.mdx | 5 +++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/apps/documentation/pages/public-api/intro.mdx b/apps/documentation/pages/public-api/intro.mdx index 06144cf45..5b4eb2445 100644 --- a/apps/documentation/pages/public-api/intro.mdx +++ b/apps/documentation/pages/public-api/intro.mdx @@ -1,8 +1,21 @@ +--- +title: 'Public API' +description: 'Learn how to interact with your documents programmatically using the Documenso public API.' +--- + # Public API +Documenso provides a public REST API that enables you to interact with your documents programmatically. The API exposes various HTTP endpoints that allow you to perform operations such as: + +- retrieving, uploading, deleting, and sending documents for signing +- creating, updating, and deleting recipients +- creating, updating, and deleting document fields + +The documentation walks you through creating API keys and using them to authenticate your API requests. You'll also learn about the available endpoints, request and response formats, and how to use the API. + ## Swagger Documentation -Documenso also provides [Swagger documentation](https://app.documenso.com/api/v1/openapi). This documentation provides information about the API endpoints, request parameters, response formats, and authentication methods. +There is also the [Swagger documentation](https://app.documenso.com/api/v1/openapi) available, which provides information about the API endpoints, request parameters, response formats, and authentication methods. ## Availability diff --git a/apps/documentation/pages/webhooks/intro.mdx b/apps/documentation/pages/webhooks/intro.mdx index c24ace032..4050ba6d2 100644 --- a/apps/documentation/pages/webhooks/intro.mdx +++ b/apps/documentation/pages/webhooks/intro.mdx @@ -1,3 +1,8 @@ +--- +title: 'Webhooks' +description: 'Learn how to use webhooks to receive real-time notifications about your documents.' +--- + # Webhooks Webhooks are HTTP callbacks that are triggered by specific events. When the user subscribes to a specific event and that event occurs, the webhook makes an HTTP request to the URL provided by the user. The request can be a simple notification or can carry a payload with more information about the event.