A webhook is a method for sending event notifications from one application to another. When something happens in a source system indicated by an event, the webhook transmits an event notification through HTTPS to a specific URL.
You can set up webhooks to receive notifications for order status updates.
A data class that represents a webhook in the system.
Attributes
| Attribute | Description |
|---|---|
url | str The URL of the webhook. |
name | str The name of the webhook. |
events | List[str] A list of events that trigger the webhook. To view the list of possible values, use get_webhook_events. |
active | bool Whether this webhook should be active after the update:
False. |
secret | Optional[str] The secret used to generate webhook signatures. |
id | Optional[str] The webhook ID. |
created_at | Optional[str] The timestamp when the webhook was created. |
updated_at | Optional[str] The timestamp when the webhook was last updated. |
Functions
Registers a created or updated webhook in the system.
Python
webhook = up42.Webhook(
name="A webhook for order updates",
url="https://receiving-url.com",
events=["order.status"],
active=True
)
webhook.save()
Retrieves a specific webhook by its ID. Returns Webhook.
| Parameter | Description |
|---|---|
webhook_id | str The webhook ID. |
Python
up42.Webhook.get(webhook_id="d290f1ee-6c54-4b01-90e6-d701748f0851")
Triggers a webhook test event to test your receiving side. The UP42 server will send test messages for each subscribed event to the specified webhook URL. Returns dict.
Python
webhook = up42.Webhook(
name="A webhook for order updates",
url="https://receiving-url.com",
events=["order.status"],
active=True
)
webhook.trigger_test_events()
Deletes a registered webhook. Returns None.
Python
webhook = up42.Webhook.get(webhook_id="d290f1ee-6c54-4b01-90e6-d701748f0851")
webhook.delete()
Retrieves all available webhook events. Returns list[dict].
Python
up42.Webhook.get_webhook_events()
Retrieves all webhooks in your workspace. Returns List["Webhook"].
Python
up42.Webhook.all()