Create event subscription | Payroc

Use this method to create an event subscription that we use to notify you when an event occurs, for example, when we change the status of a processing account.

In the request, include the events that you want to subscribe to and the public endpoint that we send event notifications to. For a complete list of events that you can subscribe to, go to Events List.

In the response, our gateway returns the id of the event subscription, which you can use to perform follow-on actions.

Use this method to create an event subscription that we use to notify you when an event occurs, for example, when we change the status of a processing account. In the request, include the events that you want to subscribe to and the public endpoint that we send event notifications to. For a complete list of events that you can subscribe to, go to [Events List](https://docs.payroc.com/knowledge/events/events-list). In the response, our gateway returns the id of the event subscription, which you can use to perform follow-on actions.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

enabledbooleanRequired

Indicates if we should notify you when the event occurs. The value is one of the following:

true - We notify you when the event occurs.
false - We don’t notify you when the event occurs.

eventTypeslist of stringsRequired

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objectsRequired

Array of polymorphic notification objects that contain information about how we contact you when an event occurs.

metadataobjectOptional

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Response headers

Locationstring

URI reference to created resource

Response

Successful request. We created the event subscription.

enabledboolean

Indicates if we should notify you when the event occurs. The value is one of the following:

true - We notify you when the event occurs.
false - We don’t notify you when the event occurs.

eventTypeslist of strings

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objects

Array of polymorphic notification objects that contain information about how we contact you when an event occurs.

idlongRead-only

Unique identifier that we assigned to the event subscription.

statusenumRead-only

Status of the subscription. We return one of the following values:

registered - You have set up the subscription, and we will notify you when an event occurs.
suspended - We have deactivated the event subscription, and we won’t notify you when an event occurs.
failed - We couldn’t contact your URI endpoint. We email the supportEmailAddress.

Allowed values:

metadataobject

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

500

Internal Server Error

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Notifications.EventSubscriptions;
4	using System.Collections.Generic;
5
6	namespace Usage;
7
8	public class Example
9	{
10	public async Task Do() {
11	var client = new PayrocClient();
12
13	await client.Notifications.EventSubscriptions.CreateAsync(
14	new CreateEventSubscriptionsRequest {
15	IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
16	Body = new EventSubscription {
17	Enabled = true,
18	EventTypes = new List<string>(){
19	"processingAccount.status.changed",
20	}
21	,
22	Notifications = new List<Notification>(){
23	new Notification(
24	new Webhook {
25	Secret = "aBcD1234eFgH5678iJkL9012mNoP3456",
26	SupportEmailAddress = "[email protected]",
27	Uri = "https://my-server/notification/endpoint"
28	}
29	),
30	}
31	,
32	Metadata = new Dictionary<string, object?>(){
33	["yourCustomField"] = "abc123",
34	}
35
36	}
37	}
38	);
39	}
40
41	}

1	{
2	"enabled": true,
3	"eventTypes": [
4	"processingAccount.status.changed"
5	],
6	"notifications": [
7	{
8	"type": "webhook",
9	"secret": "**********oP3456",
10	"supportEmailAddress": "[email protected]",
11	"uri": "https://my-service/notification/endpoint"
12	}
13	],
14	"id": 2565435189324,
15	"status": "registered",
16	"metadata": {
17	"yourCustomField": "abc123"
18	}
19	}

Authentication

Headers

Request

Response headers

Response

Errors