Skip to content

Public API: unsubscribe from an event

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

Unsubscribing from an event

A quick reminder: the event types available in Pneumatic 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

To unsubscribe from a specific event use the endpoint POST https://api.pneumatic.app/webhooks/events/event_name/unsubscribe

Note, you don't need to supply a specific url you want unsubscribed. Seeing how in Pneumatic you can only have one url listening to a specific event, the unsubscribe command will just delete whatever url is in there.

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/unsubscribe'

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

If r.ok is True you've successfully unsubscribed from the event.