📚 Add webhooks info to the teams section

This commit is contained in:
Andrés Moya 2023-02-08 17:11:12 +01:00
parent e924273ab3
commit 48967f40b9
6 changed files with 10 additions and 2 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 28 KiB

BIN
img/teams-webhooks.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View File

@ -21,7 +21,8 @@ In Penpot, webhooks are configured at Team level:
![Add a webhook](/img/webhooks.png)
When you add a webhook, you specify the URL of a service you own. If the webhook
is active, the URL will be called on any event that occurs anywhere in the team.
is active, a POST request will be sent to the URL on any event that occurs anywhere
in the team.
You can specify the format of the call payload.
@ -32,7 +33,7 @@ information and enriches the content with semantic information.
### Events list
Unfortunately, we still have not a separated documentation for the webhook events.
Unfortunately, we do not have any specific documentation for the webhooks yet.
For the moment you can use the <a href="https://design.penpot.app/api/_doc"
target="_blank">backend API documentation</a>, generated automatically from <a
href="https://github.com/penpot/penpot/tree/main/backend/src/app/rpc"

View File

@ -64,3 +64,10 @@ title: 15· Teams
</ul>
<p><img src="/img/teams-invitations-actions.png" alt="teams" /></p>
<h3 id="teams-webhooks">Webhooks</h3>
<p>Webhooks allow other websites and apps to be notified when certain events happen on Penpot, ensuring to create integrations with other services. While we are still working on a plugin system, this is a clever and simple way to create integrations with other services.</p>
<p><img src="/img/teams-webhooks.png" alt="webhooks" /></p>
<p>You can find detailed info about Penpot webhooks at the <a href="/technical-guide/integration/#webhooks">Technical Guide</a>.</p>