Skip to content

Webhooks

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 via HTTPS to a specific URL.

See notification events

You can set up webhooks to receive notifications in the following cases:

  • Job status updates. Every time a job changes its status.
  • Order status updates. When a new order has been completed — successfully or not.
events = up42.get_webhook_events()
print(events)

Create and test a new webhook

webhook = up42.create_webhook(
    name="new-webhook",
    url="https://receiving-url.com",
    events=events,
    active=True
)
webhook.trigger_test_event()

Manage existing webhooks

Modify you webhook:

webhooks = up42.get_webhooks()
webhooks[0].update(
    name="new-webhook",
    url="https://receiving-url.com",
    events=events,
    active=False
)

Delete your webhook:

webhooks = up42.get_webhooks()
webhooks[0].delete()

Learn more