Skip to content

Public API: webhook events

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

Webhook events

The GET https://api.pneumatic.app/webhooks/events endpoint lets you get hold of all the events you can subcribe to in Pneumatic.

Python example:

import requests

api_key = 'your_api_key'
headers = {
  'Authorization': f'Bearer {api_key}'
}
end_point = 'https://api.pneumatic.app/webhooks/events'
r = requests.get(end_point, headers=headers)

The response this endpoint returns a list of events with urls subscribed to each in your account(based off your API key):

[
  {
     "event": 'workflow_completed',
     "url": str | null
  },
  {
     "event": 'workflow_started',
     "url": str | null
  },
    {
     "event": 'task_completed_v2',
     "url": str | null
  },
  {
     "event": 'task_returned',
     "url": str | null
  }
]

You'd use this endpoint to let your external app see which urls are listening to which events in your Pneumatic account.