Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-14 00:32:43 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: content updates

Browse Source
This commit is contained in:
Catalin Pit
2024-04-26 10:25:16 +03:00
parent c7beda4dd2
commit 5a9ac21443
2 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
apps/documentation/pages/public-api/intro.mdx
View File

@ -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

5
apps/documentation/pages/webhooks/intro.mdx
View File

@ -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.