List event subscriptions | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.Notifications.EventSubscriptions;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new PayrocClient();
        await client.Notifications.EventSubscriptions.ListAsync(
            new ListEventSubscriptionsRequest {
                Status = ListEventSubscriptionsRequestStatus.Registered,
                Event = "processingAccount.status.changed"
            }
        );
    }
}

1	{
2	"count": 2,
3	"data": [
4	{
5	"enabled": true,
6	"eventTypes": [
7	"processingAccount.status.changed"
8	],
9	"notifications": [
10	{
11	"type": "webhook",
12	"secret": "**********oP3456",
13	"supportEmailAddress": "[email protected]",
14	"uri": "https://my-service/notification/endpoint"
15	}
16	],
17	"id": 2565435189324,
18	"status": "registered",
19	"metadata": {
20	"yourCustomField": "abc123"
21	}
22	},
23	{
24	"enabled": true,
25	"eventTypes": [
26	"processingAccount.riskStatus.changed"
27	],
28	"notifications": [
29	{
30	"type": "webhook",
31	"secret": "**********oP3456",
32	"supportEmailAddress": "[email protected]",
33	"uri": "https://my-service/notification/endpoint"
34	}
35	],
36	"id": 2565435189325,
37	"status": "registered",
38	"metadata": {
39	"yourCustomField": "abc123"
40	}
41	}
42	],
43	"hasMore": false,
44	"limit": 10,
45	"links": [
46	{
47	"rel": "next",
48	"method": "get",
49	"href": "https://api.payroc.com/v1/event-subscriptions?after=10&limit=10"
50	}
51	]
52	}

Use this method to return a paginated list of event subscriptions that are linked to your ISV account.

Note: If you want to view the details of a specific event subscription and you have its id, use our Retrieve Event Subscription method.

Use query parameters to filter the list of results that we return, for example, to search for subscriptions with a specific status or an event type.

Our gateway returns the following information about each subscription in the list:

Event types that you have subscribed to.
Whether you have enabled notifications for the subscription.
How we contact you when an event occurs, including the endpoint that send notifications to.
If there are any issues when we try to send you a notification, for example, if we can’t contact your endpoint.

For each event subscription, we also return its id, which you can use to perform follow-on actions.

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of event subscriptions that are linked to your ISV account. **Note:** If you want to view the details of a specific event subscription and you have its id, use our [Retrieve Event Subscription](https://docs.payroc.com/api/schema/notifications/event-subscriptions/retrieve) method. Use query parameters to filter the list of results that we return, for example, to search for subscriptions with a specific status or an event type. Our gateway returns the following information about each subscription in the list: - Event types that you have subscribed to. - Whether you have enabled notifications for the subscription. - How we contact you when an event occurs, including the endpoint that send notifications to. - If there are any issues when we try to send you a notification, for example, if we can't contact your endpoint. For each event subscription, we also return its id, which you can use to perform follow-on actions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenumOptional

Filter event subscriptions by subscription status.

Allowed values:

eventstringOptional

Filter event subscriptions by an event type. For a list of event types, go to Events List.

Response

Successful request. Returns a list of event subscriptions.

countinteger

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

datalist of objects

Array of eventSubscription objects.

hasMoreboolean

Indicates whether there is another page of results available.

limitinteger

Maximum number of results that we return for each page.

linkslist of objects

Reference links to navigate to the previous page of results or to the next page of results.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error