Retrieve event subscription

Browse API reference

GET/event-subscriptions/{subscriptionId}getEventSubscription

Use this method to retrieve the details of an event subscription.

In your request, include the subscriptionId that we sent to you when we created the event subscription.

Note: If you don't know the subscriptionId of the event subscription, go to List event subscriptions.

Parameters

Name	In	Type	Description
`subscriptionId`Required	path	`integer`	Unique identifier that we assigned to the event subscription. Note: Our gateway returned the subscriptionId in the id field in the response of the Create Event Subscription method.

Responses

Returns the event subscription object.

200 OK · application/json

{
  "enabled": true,
  "eventTypes": [
    "processingAccount.status.changed"
  ],
  "id": 2565435189324,
  "metadata": {
    "yourCustomField": "abc123"
  },
  "notifications": [
    {
      "secret": "**********oP3456",
      "supportEmailAddress": "jane.doe@example.com",
      "type": "webhook",
      "uri": "https://my-server/notification/endpoint"
    }
  ],
  "status": "registered"
}

Response schema · 11 fields

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.
eventTypesstring[]required
Array of events that you want to subscribe to. For a list of events, go to Events List.
idintegerint64
Unique identifier that we assigned to the event subscription.
metadataobject
Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.
notificationsobject[]required
Array of polymorphic notification objects that contain information about how we contact you when an event occurs.
- option 1object
  - secretstringrequired
    String that we send with a notification so that you can ensure it is a valid notification from our gateway. We include the value in the Payroc-Secret header parameter in the webhook call. Note: In the response, we truncate the secret to the last 16 characters and mask the first 10 characters.16–64 chars
  - supportEmailAddressstringrequired
    Email address of the person or team that we contact if we can't deliver notifications.
  - typestringrequired
    Type of notification method. Note: To receive notifications by webhook, your server must be able to handle POST requests.webhook
  - uristringrequired
    Public endpoint that we send notifications to.
statusstring
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.registeredsuspendedfailed

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

create-event-subscription