Skip to content

Add documentation: Webhook Events Documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

quantstruct-dev-newman[bot]
Copy link

Webhook Events Documentation

Webhook Overview

Webhooks are automated HTTP callbacks triggered by specific events occurring within our system. They provide a real-time mechanism for your application to receive updates without constantly polling our API. When an event of interest happens, we send an HTTP POST request to the URL you configure, containing data about the event in the request body. This allows your application to react immediately to changes and maintain up-to-date information.

This document provides detailed information about the different types of webhook events, their payload structures, security considerations, and a guide to implementing webhook handling in your application.

Event Types

This section describes the different types of events that can trigger webhooks. Each event type corresponds to a specific action or state change within our system.

| Event Type | Description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants