Skip to content

Public API: Get Webhook Event

Isaiah Fisher edited this page Dec 18, 2024 · 1 revision

The GET https://api.pneumatic.app/webhooks/events/event_name endpoint lets you see all the urls subscribed to a specific event in your Pneumatic account. The event name/event type is passed in as part of the url. The event types Pneumatic currently supports are as follows:

event type description
workflow_completed the event gets triggered when any workflow in your Pneumatic account gets completed
workflow_started the event gets triggered at the start of any workflow in your Pneumatic account
task_complted_v2 the event is triggered whenever a task (any task) is completed in your Pneumatic account
task_returned the event gets triggered whenever a task is returned in your Pneumatic account

Python example:

import requests

api_key = 'your_api_key'
headers = {
  'Authorization': f'Bearer {api_key}'
}
end_point = 'https://api.pneumatic.app/webhooks/events/event_name'

r = requests.get(
  end_point,
  headers=headers,
)

The endpoint returns a json with the urls subscribed to the event:

{
   "url": str | null
}