Event Sources
Create Event Source
Add an additional type for which this event subscription will trigger
Request
POST /event_subscriptions/{subscription_id}/sources
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
subscription_id | string | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | Type of event for which an event subscription will trigger |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
type | string | Type of event for which an event subscription will trigger |
uri | string | URI of the Event Source API resource. |
Delete Event Source
Remove a type for which this event subscription will trigger
Request
DELETE /event_subscriptions/{subscription_id}/sources/{type}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Event Source
Get the details for a given type that triggers for the given event subscription
Request
GET /event_subscriptions/{subscription_id}/sources/{type}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
type | string | Type of event for which an event subscription will trigger |
uri | string | URI of the Event Source API resource. |
List Event Sources
List the types for which this event subscription will trigger
Request
GET /event_subscriptions/{subscription_id}/sources
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
sources | EventSource | The list of all Event Sources for an Event Subscription |
uri | string | URI of the next page, or null if there is no next page. |
EventSource fields
| Name | Type | Description |
|---|---|---|
type | string | Type of event for which an event subscription will trigger |
uri | string | URI of the Event Source API resource. |
Update Event Source
Update the type for which this event subscription will trigger
Request
PATCH /event_subscriptions/{subscription_id}/sources/{type}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
subscription_id | string | The unique identifier for the Event Subscription that this Event Source is attached to. |
type | string | Type of event for which an event subscription will trigger |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
type | string | Type of event for which an event subscription will trigger |
uri | string | URI of the Event Source API resource. |