Webhooks are a way for us to provide your applications with real-time information. They allow applications to receive notifications about specific events, such as a payment link created or a payment link paid. This allows you to automate workflow of your application as per your business requirement based on the events happening in your Speed account.
In order to receive live notifications, you must register a webhook endpoint and enable the desired events. To create a webhook endpoint, you must provide a publicly accessible HTTPS URL and a list of enabled_events.
You will be able to add the same webhook endpoint URL multiple times.
{
"id": "we_lbenid1iscFTU7N",
"object": "webhook.endpoint",
"api_version": "2022-10-15",
"enabled_events": [
"payment.created"
],
"livemode": true,
"status": "active",
"url": "https://speed.abc.com/f9304-9a05-4228-aa4f-73fdf1be964e",
"secret": "wsec_/35OeRymnQzGvej6PSURUDQYoZLwhp",
"description": "abc",
"connect": "false",
"created": 1670478066054,
"modified": 1670478066054
}
Attributes
id string
Unique identifier for the object.
object string
The type of the object indicates to which entity this response belongs.
livemode boolean
If the object is in live mode, it has the value true; otherwise, it has the value false.
status enum
A webhook endpoint object can have 2 statuses as mentioned below.
- active
- Upon generation, by default, it will be active until deactivated.
- deactivated You can manually deactivate a webhook endpoint when you don't intend to receive notifications via it.
api_version string
Specifies the API version for which all the events of the webhook endpoint are rendered. The default api_version is 2022-04-15.
enabled_events string
The list of all your enabled events.
url string
The URL of the webhook endpoint.
secret string
The endpoint’s secret is to ensure that the real-time notifications sent are indeed from Speed.
description string
A description of the webhooks endpoint.
connect boolean
To receive notifications for the connected account, set this value to 'true'. If you prefer notifications for your own account, set it to 'false'. Until explicitly specified it will be considered as ‘false’.
created timestamp
Time at which the webhook endpoint object was created.
modified timestamp
Time at which the last modification was made.