Webhooks are a powerful feature that allows your application to receive real-time notifications about specific events that occur within the Edge platform. By setting up webhooks, you can automate processes, update records, and trigger workflows in your application as soon as an event happens.
Webhooks are user-defined HTTP callbacks that are triggered by specific events. When one of those events is triggered, Edge will send an HTTP POST request to the webhook URL you specify. This request contains details about the event, allowing your application to handle the event data in real-time.
Webhooks enable your application to respond to events as they happen, ensuring that your system stays up-to-date without the need for constant polling.
Get notified when a payment is successful or fails, and update your records accordingly.
Receive updates when an account is created, updated, or deleted.
Monitor transactions in real-time, enabling immediate action or analysis.
Set up webhooks for any custom events that are crucial to your business operations.
To start using webhooks, you need to configure them through the Edge Dashboard. Follow the steps below to set up your webhooks:
Log in to the Edge Dashboard
Begin by logging in to your Edge account. Once logged in, navigate to the Dashboard.
Navigate to the Webhooks Section
In the Dashboard, find the Webhooks section. This is typically located under the API Settings or Integrations tab.
Create a New Webhook
Test the Webhook
After setting up the webhook, you should test it to ensure it works as expected.
200 OK
status code. This indicates that the webhook was received and processed successfully.Ensure that your server responds quickly to webhook requests. Webhooks that do not receive a 200 OK
response may be retried multiple times by Edge.
Here’s the guide rewritten using the Steps component to clearly outline the process for handling webhooks in your application:
When your application receives a webhook, it’s important to handle it efficiently and securely. Follow these steps to manage incoming webhooks:
Step 1: Parse the Incoming Request
Webhooks are sent as HTTP POST requests with a JSON payload. Your application needs to parse this payload to extract the event data.
Step 2: Verify the Webhook
If you have set a secret key, you should verify the signature included in the webhook request headers. This verification ensures that the request is authentic and actually from Edge.
Step 3: Handle the Event
Based on the event type and data, your application should execute the appropriate logic. For example, if you receive a payment.success
event, you might update the transaction status in your database.
Step 4: Respond to the Webhook
Always respond to the webhook request with a 200 OK
status code once your application has processed the event. This response tells Edge that the webhook was received and handled successfully.
Ensure your webhook endpoint is secure. Consider implementing rate limiting and verifying the signature of incoming requests to prevent unauthorized access.
Webhooks are a powerful feature that allows your application to receive real-time notifications about specific events that occur within the Edge platform. By setting up webhooks, you can automate processes, update records, and trigger workflows in your application as soon as an event happens.
Webhooks are user-defined HTTP callbacks that are triggered by specific events. When one of those events is triggered, Edge will send an HTTP POST request to the webhook URL you specify. This request contains details about the event, allowing your application to handle the event data in real-time.
Webhooks enable your application to respond to events as they happen, ensuring that your system stays up-to-date without the need for constant polling.
Get notified when a payment is successful or fails, and update your records accordingly.
Receive updates when an account is created, updated, or deleted.
Monitor transactions in real-time, enabling immediate action or analysis.
Set up webhooks for any custom events that are crucial to your business operations.
To start using webhooks, you need to configure them through the Edge Dashboard. Follow the steps below to set up your webhooks:
Log in to the Edge Dashboard
Begin by logging in to your Edge account. Once logged in, navigate to the Dashboard.
Navigate to the Webhooks Section
In the Dashboard, find the Webhooks section. This is typically located under the API Settings or Integrations tab.
Create a New Webhook
Test the Webhook
After setting up the webhook, you should test it to ensure it works as expected.
200 OK
status code. This indicates that the webhook was received and processed successfully.Ensure that your server responds quickly to webhook requests. Webhooks that do not receive a 200 OK
response may be retried multiple times by Edge.
Here’s the guide rewritten using the Steps component to clearly outline the process for handling webhooks in your application:
When your application receives a webhook, it’s important to handle it efficiently and securely. Follow these steps to manage incoming webhooks:
Step 1: Parse the Incoming Request
Webhooks are sent as HTTP POST requests with a JSON payload. Your application needs to parse this payload to extract the event data.
Step 2: Verify the Webhook
If you have set a secret key, you should verify the signature included in the webhook request headers. This verification ensures that the request is authentic and actually from Edge.
Step 3: Handle the Event
Based on the event type and data, your application should execute the appropriate logic. For example, if you receive a payment.success
event, you might update the transaction status in your database.
Step 4: Respond to the Webhook
Always respond to the webhook request with a 200 OK
status code once your application has processed the event. This response tells Edge that the webhook was received and handled successfully.
Ensure your webhook endpoint is secure. Consider implementing rate limiting and verifying the signature of incoming requests to prevent unauthorized access.