Get an Event Subscription

GET

/v1/event_subscriptions/:id

Retrieve an event subscription with the given ID.

idstringRequired

The unique identifier for the event subscription

This endpoint returns an object.

urlstring

The webhook url where we’ll send notifications.

idstringOptional

The unique identifier for the event subscription

created_atdatetimeOptional

The date and time the event subscription was created

statusenumOptional

Allowed values: activedisableddeletedrequires_attention

The status of the event subscription. This indicates if we’ll send notifications to this subscription

active: subscription is active and events will be delivered normally
disabled: subscription is temporarily disabled and events will not be delivered
deleted: subscription has been deleted and events will not be delivered
requires_attention: subscription has been disabled due to delivery failures and events will not be delivered

categoryenumOptional

Allowed values: grant.createdgrant.updatedunintegrated_grant.createdunintegrated_grant.updated

The category of the event. This is useful for filtering events.

1	{
2	"url": "https://example.com/webhook",
3	"id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
4	"created_at": "2024-01-14T12:48:56Z",
5	"status": "active",
6	"category": "grant.created"
7	}

1	curl https://api.givechariot.com/v1/event_subscriptions/id \
2	-H "Authorization: Bearer <token>"