SIsilverflow
Event Subscriptions

Create Event Subscription

This operation creates a new Event Subscription for the given event source. When the subscription is created successfully, a test event will be sent to the targetUrl.

Requires eventSubscriptions:Create permission.

post/eventSubscriptions

Request

Request body

descriptionstring
eventSource'https://silverflow.com/charges' | 'https://silverflow.com/clearing' | 'https://silverflow.com/complianceCases' | 'https://silverflow.com/currencyRates' | 'https://silverflow.com/disputes' | 'https://silverflow.com/documents' | 'https://silverflow.com/enrollments' | 'https://silverflow.com/fraudNotifications' | 'https://silverflow.com/networkTokens' | 'https://silverflow.com/processorTokens' | 'https://silverflow.com/reconciliation' | 'https://silverflow.com/reports' | 'https://silverflow.com/distributions' | 'https://silverflow.com/ammfSubmissions' required
targetUrlstring required

A valid URL

Response

The created Event Subscription

keystring required
agentKeystring required

Uniquely identifies an Agent

status'active' | 'archived' required

The status of the Event Subscription

descriptionstring
eventSourcestring required

A valid URL

eventDataSchemastring required

A valid URL

targetUrlstring required

A valid URL

createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

versioninteger required

The version of this object

Example response

{
  "key": "sub-4JYVetlH0BhpW2bpHAAL",
  "status": "active",
  "agentKey": "cgt-24OJ9rv4u6x5jEu3MP91",
  "description": "Disputes Data lake feed",
  "eventSource": "https://silverflow.com/disputes",
  "eventDataSchema": "https://silverflow.com/schemas/events/disputes/1.0",
  "targetUrl": "https://my.server.com/events/disputes",
  "created": "2025-04-22T12:26:34.341Z",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.