Manage Webhooks in Settings

Short summary

Use Webhooks to send real-time event notifications from Proposaly to an external endpoint. You can add destinations, choose events, review delivery logs, and resend failed or past deliveries.

When to use this feature

Use Webhooks when you want to:

• send Proposaly events to external systems
• automate follow-up actions in CRMs, ERPs, or communication tools
• monitor webhook delivery results for each destination

Step-by-step instructions

1. In the Business Portal, go to Menu → Company → Settings, then open the "Webhooks" tab.

!Screenshot: Webhooks list in Settings

1. Click "+ Add destination" to create a new event destination, or open the 3 dots menu on an existing row and click "Edit".

1. In the dialog, enter the "Endpoint URL" and optional "Description".

1. If you are editing an existing destination, you can also change "Status" and copy the "Secret key".

!Screenshot: Edit destination dialog

1. Click "Next".

1. Select the events this destination should listen to. 

1. Complete the setup. The destination appears in the "Event destination" table.

1. To find a destination later, use the "Status", "Workspace", and "Search" filters, or change sorting with "Sort by".

1. To pause, resume, test, edit, or delete a destination, open the 3 dots menu on its row.

1. To review deliveries, click a destination in the table. You can view past events, delivery status, attempts, and payload details.

!Screenshot: Webhook delivery log

1. On the delivery log page, click "Resend" to send the selected event again, or click "Back" to return to the table.

Notes & limitations

• Webhooks are managed in "Settings" under the "Webhooks" tab.
• Each destination has its own "Secret key".
• Deliveries are shown per destination in the log view.
• You can filter destinations by status and workspace.
• Available destination statuses are "Active", "Paused", and "Deleted".
• The list supports these page sizes: 10, 20, and 50.
• The default sort is "Newest first".
• The default status filter is "Active".
• Webhook payloads are sent as JSON POST requests.
• If a delivery fails, Proposaly retries it automatically.

Troubleshooting

Why is my destination not receiving events?

• Check that the "Endpoint URL" is correct.
• Make sure the destination is not paused.
• Confirm that the required events are selected for that destination.
• Review the delivery log for the response status and attempts.

Why do I see failed deliveries?

• A delivery fails when the endpoint returns a non-2xx response or does not respond within 10 seconds.
• Proposaly retries failed deliveries automatically.

How do I test a destination?

• Open the 3 dots menu for the destination and click "Run".

How do I verify that a webhook came from Proposaly?

• Use the destination's "Secret key" to validate the signature in the "X-Proposaly-Signature" header.