If you want to stay informed about specific events within DailyBot, you can create a webhook subscription. Webhooks allow you to receive real-time notifications at a designated endpoint, keeping you in the loop about crucial activities.
Endpoint: POST /webhook-subscription/
Query String Parameters:
-
hook_url
(required): The endpoint that will be receiving events. -
name
: String - Contains the webhook name. -
subscriptions
: String list - Specify the type of events you are interested in receiving. -
subscribed_objects
: String list - Provide the UUIDs of the check-ins or forms that you want to receive events from.
Request Example:
"hook_url": string(URL),
"subscribed_objects": [string(CheckinUUID),...],
"subscriptions": [string(EventSubscribed),...],
"bearer": string(optional),
"immediate_sample_event": boolean
}
- The "EventSubscribed" is a string defining a type of event. You can refer to the available types of events.
- The
bearer
is optional. If specified, the webhook will always include that value in the "X-BEARER" HTTP header. - If
immediate_sample_event
is set as true, DailyBot will send a sample payload to that URL immediately upon the creation of this outgoing webhook.
Now, let's break down the process:
-
Access the Webhook Subscription Endpoint: Use the
POST
method towebhook-subscription/
. -
Provide Essential Information:
-
hook_url
: Enter the endpoint URL where you want to receive webhook events. -
name
: Optionally, give a name to your webhook for easy identification. -
subscriptions
: Specify the type of events you're interested in (e.g., "CheckinCreated", "FormSubmitted"). -
subscribed_objects
: Provide the UUIDs of the check-ins or forms you want events from.
-
-
Optional Parameters:
-
bearer
: If you have a specific token for authentication, include it here. -
immediate_sample_event
: Decide whether you want to receive a sample payload immediately upon webhook creation.
-
-
Submit the Request: Send the configured request to create your webhook subscription.
By following these steps, you'll have a webhook subscription ready to keep you informed about the events that matter to you in DailyBot. If you encounter any issues or have further questions, don't hesitate to contact our support team at support@dailybot.com.
Comments
0 comments
Article is closed for comments.