OS1 Services
Webhooks

5min
Introduction
The Webhook service provides a simple, streamlined, and reliable conduit between the event publishers and subscribers. For publishers, developers of services that generate events, it offers an efficient way to broadcast these events without complex integrations like Kafka streams. 
On the other hand, subscribers, mainly app developers, can easily subscribe to these events, enabling real-time responsiveness in their applications. This service simplifies the process of sending and receiving event notifications, ensuring seamless and real-time data flow between publishers and subscribers.
How it Works
﻿
Here's a brief overview of the process:

Create App Configuration: Apps that want to act as publishers need to register   using two details: their permission requirements for subscribers and a name that subscribers will use to identify the app.
Event Registration: Publishers register their events with the webhook service, detailing the events they will broadcast.
Event Subscriptions: Consumer apps can retrieve and subscribe to registered events and specify which event types they want updates on.
Processing and Filtering: The webhook service processes events, applies necessary filters, and forwards only the relevant events to the subscribers' specified webhook endpoints.
Customizable Subscriptions: Subscriptions can be customized to include either core, custom, or both attributes of the events.
Reliable Delivery: The service ensures reliable delivery of events, managing retries and backoffs effectively in case of any delivery issues to guarantee that events reach their intended destinations.
APIs
App Configurations
﻿CreateAppConfig: Registers configuration for an app publishing events
﻿GetAppConfigDetails: Retrieves the configuration details for registered apps
﻿UpdateAppConfig: Updates configuration details for an app
Events Registration APIs for Publishers
﻿RegisterEvents: Register multiple event configurations.
﻿GetPublisherEvents: Retrieve all registered events.
﻿UpdatePublisherEvents: Update details and configurations of specific events.
﻿BulkDeleteEvents: Facilitate bulk deletion of registered events.
Subscriptions APIs for Consumers
﻿CreateSubscription: Create a new subscription to webhook notifications for specific
﻿GetSubscriptions: Retrieve a paginated list of subscriptions for an application.
﻿UpdateSubscription: Update configurations of an existing subscription.
﻿GetSubscriptionById: Fetch details of a specific subscription using its ID.
﻿UpdateSubscriptionsEvents: Add or remove events from an existing subscription.
﻿GetSubscriptionsExecutions: Obtain a paginated list of executions for a specific subscription.
﻿
Updated 17 Sep 2024
Did this page help you?
Search Query Format
Publishing Webhook Events