{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Webhook Events and Subscriptions","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webhook-events-and-subscriptions","__idx":0},"children":["Webhook Events and Subscriptions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Peach supports various event types across different categories that you can subscribe to. For example, subscribing to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["autopay.schedule.changed "]},"allows you to receive a notification when an autopay schedule changes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieving-events","__idx":2},"children":["Retrieving Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve events, call the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-docs/api-public#tag/Events-and-Webhooks-Management"},"children":["Retrieve Events"]}," request and specify query parameters for the events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-parameters","__idx":3},"children":["Query Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following query parameters can be used to filter and customize your event retrieval:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," (integer, 1-100, default: 25): The maximum count of results to retrieve."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startingAfter"]}," (string): Return results starting after the provided object identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endingBefore"]}," (string): Return results ending before the provided object identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortBy"]}," (array of strings): The data attributes by which to sort the results."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personId"]}," (string): Filter by a Borrower's unique identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periodId"]}," (string): Limit results to a specific periodId."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanId"]}," (string): Filter by Loan's unique identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseId"]}," (string): Filter by case's object unique identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}," (string): Filter by transaction's unique identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAtFrom"]}," (string, date-time): Get events created at or after the specified time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAtTo"]}," (string, date-time): Get events created before the specified time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["effectiveAtFrom"]}," (string, date-time): Get events effective at or after the specified time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["effectiveAtTo"]}," (string, date-time): Get events effective before the specified time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accrualDate"]}," (string, date): Get events by matching accrual date (for AccrueInterestEvent only)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeDeleted"]}," (boolean, default: true): Include events that have been deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["events"]}," (string): A comma-separated list of event names to return. Use wildcards for broader matching."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeEvents"]}," (string): A comma-separated list of event names to exclude from the response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhookId"]}," (string): The webhook ID to filter events by."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["creatingMessageIds"]}," (array of strings): A comma-separated list of creatingMessageIds to return."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":4},"children":["Example Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following request retrieves up to 25 of the most recent webhook events."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api.peach.finance/api/events?limit=25' \\\n--header 'Accept: application/json' \\\n--header 'X-API-KEY: <YOUR-API-KEY>'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-structure","__idx":6},"children":["Response Structure"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"status\": 200,\n    \"data\": [/* Array of event objects */],\n    \"total\": <total_count>,\n    \"count\": <returned_count>,\n    \"nextUrl\": <url_for_next_page>,\n    \"previousUrl\": <url_for_previous_page>\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"event-object-properties","__idx":7},"children":["Event Object Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for the event"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eventType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of event (e.g., \"payment.initiated\", \"loan.activated\")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eventClass"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Class of the event (e.g., \"PaymentInitiatedEvent\")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["effectiveAt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 8601 timestamp when the event took effect"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["createdAt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 8601 timestamp when the event was created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["loanId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated loan ID (if applicable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["personId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated person ID (if applicable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentInstrumentId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated payment instrument ID (if applicable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated transaction ID (if applicable)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pagination","__idx":8},"children":["Pagination"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes URLs for the next and previous pages of results:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextUrl"]},": URL to retrieve the next page of events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousUrl"]},": URL to retrieve the previous page of events"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":9},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"status\": 200,\n    \"data\": [\n        {\n            \"id\": \"EV-L9BN-5J52\",\n            \"eventType\": \"payment.instrument.deactivated\",\n            \"eventClass\": \"PaymentInstrumentDeactivatedEvent\",\n            \"effectiveAt\": \"2020-03-18T21:08:03.736597+00:00\",\n            \"createdAt\": \"2020-03-19T08:23:52.545701+00:00\",\n            \"paymentInstrumentId\": \"PT-L9BN-Z5B5\"\n        }\n        // ... additional events\n    ],\n    \"total\": 10000,\n    \"count\": 25,\n    \"nextUrl\": \"https://sandboxapi.peach.finance/api/events?limit=25&startingAfter=EV-7NBP-61KG\",\n    \"previousUrl\": \"https://sandboxapi.peach.finance/api/events?limit=25&endingBefore=EV-L9BN-5J52\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-event-types","__idx":10},"children":["Common Event Types"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment.initiated"]},": Payment initiation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment.succeeded"]},": Successful payment completion"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loan.activated"]},": Loan activation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loan.originated"]},": Loan origination"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment.instrument.deactivated"]},": Payment instrument deactivation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the full list of events ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-docs/api-public/events"},"children":["here"]}]}]},"headings":[{"value":"Webhook Events and Subscriptions","id":"webhook-events-and-subscriptions","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Retrieving Events","id":"retrieving-events","depth":2},{"value":"Query Parameters","id":"query-parameters","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"Response","id":"response","depth":2},{"value":"Response Structure","id":"response-structure","depth":3},{"value":"Event Object Properties","id":"event-object-properties","depth":3},{"value":"Pagination","id":"pagination","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"Common Event Types","id":"common-event-types","depth":2}],"frontmatter":{"seo":{"title":"Webhook Events and Subscriptions"}},"lastModified":"2026-10-27T01:01:07.862Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-tools/webhooks/webhook-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}