Webhooks in SDK

Overview

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.

View repository

Class: Webhook

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: `True`: The webhook is active. `False`: The webhook isn’t active. The default value is `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.

1
# Select a webhook
2
webhook_id = "d290f1ee-6c54-4b01-90e6-d701748f0851"
3

4
# Fetch webhook info
5
webhook = up42.Webhook.get(webhook_id=webhook_id)
6

7
# Define output
8
print(f"ID:         {webhook.id}")
9
print(f"Name:       {webhook.name}")
10
print(f"URL:        {webhook.url}")
11
print(f"Active:     {webhook.active}")
12
print(f"Events:     {webhook.events}")
13
print(f"Created at: {webhook.created_at}")
14
print(f"Updated at: {webhook.updated_at}")

Methods

save

Registers a created or updated webhook in the system.

1
# Instantiate a new webhook
2
webhook = up42.Webhook(
3
    name="My order status Webhook",
4
    url="https://example.com/my-webhook-callback",
5
    events=["order.status"],
6
    active=True,
7
    secret="secret-to-validate-payloads"
8
)
9

10
# Save the webhook
11
webhook.save()
12

13
# The object is updated with the server response
14
print("\nWebhook created successfully:")
15
print(f"ID:          {webhook.id}")
16
print(f"Name:        {webhook.name}")
17
print(f"URL:         {webhook.url}")
18
print(f"Active:      {webhook.active}")
19
print(f"Created at:  {webhook.created_at}")

1
# Select an existing webhook that you want to update
2
webhook_id = "d290f1ee-6c54-4b01-90e6-d701748f0851"
3

4
# Fetch webhook info
5
webhook = up42.Webhook.get(webhook_id=webhook_id)
6

7
# Modify its attributes
8
webhook.name = "Test webhook"
9
webhook.url = "https://example.com/my-webhook-callback"
10
webhook.events=["order.status"]
11
webhook.active = False
12
webhook.secret="secret-to-validate-payloads"
13

14
# Save the webhook
15
webhook.save()
16

17
# The object is updated with the server response
18
print("\nWebhook updated successfully:")
19
print(f"Updated at: {webhook.updated_at}")

get

Retrieves a specific webhook by its ID. Returns Webhook.

Parameter	Description
`webhook_id`	str The webhook ID.

1
# Select a webhook
2
webhook_id = "d290f1ee-6c54-4b01-90e6-d701748f0851"
3

4
# Fetch webhook info
5
webhook = up42.Webhook.get(webhook_id=webhook_id)

trigger_test_events

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.

1
# Select a webhook
2
webhook_id = "d290f1ee-6c54-4b01-90e6-d701748f0851"
3

4
# Fetch webhook info
5
webhook = up42.Webhook.get(webhook_id=webhook_id)
6

7
# Trigger the test events
8
test_event_info = webhook.trigger_test_events()
9

10
# Define output
11
print(test_event_info)

delete

Deletes a registered webhook. Returns None.

1
# Select a webhook
2
webhook_id = "d290f1ee-6c54-4b01-90e6-d701748f0851"
3

4
# Fetch webhook info
5
webhook = up42.Webhook.get(webhook_id=webhook_id)
6

7
# Delete the webhook
8
webhook.delete()

get_webhook_events

Retrieves all available webhook events. Returns list[dict].

1
# Search for event types
2
events = up42.Webhook.get_webhook_events()
3

4
# Define output
5
for event in events:
6
    print(f"- Name:        {event['name']}")
7
    print(f"  Description: {event['description']}\n")

all

Retrieves all webhooks in your workspace. Returns List["Webhook"].

1
# Search for webhooks
2
webhooks = up42.Webhook.all()
3

4
# Define output
5
for webhook in webhooks:
6
    print(f"- ID:     {webhook.id}")
7
    print(f"  Name:   {webhook.name}")
8
    print(f"  URL:    {webhook.url}")
9
    print(f"  Active: {webhook.active}")
10
    print(f"  Events: {', '.join(webhook.events)}\n")