Create Webhook

Description

The Create Webhook endpoint allows you to set up a webhook that listens for specific events and sends notifications to your specified URL. Webhooks are useful for integrating real-time event data into your applications.

HTTP Request

POST /webhooks

Authentication

All requests must include an Authorization header with a valid API key.

Headers

Request Body

• url: The URL where the webhook notifications will be sent.
• name: A descriptive name for the webhook.
• secret: A secret key to secure webhook payloads.
• enabled: string indicating whether the webhook is active.

JSON

Request Example

 
webhook = client.create_webhook(
    url="https://your-domain.com/webhook",   # Your custom domain where the events notifications will be sent
    name="Processing Events",                # Webhook name
    enabled="true",                          # Webhook Enabled (true/false)
    secret="your-webhook-secret"             # Add a layer of security with secret
)
 
print(webhook)

Response

Success

Status Code: 201 Created

Body:

{
   "data": {
       "webhook": {
           "id": 38,
           "name": "testing_1",
           "enabled": "true",
           "created_at": "2025-01-24T10:53:53.000000Z",
           "updated_at": "2025-01-24T10:53:53.000000Z"
       }
   }
}