Skip to main content
API docs by Redocly

Paystar Events API (1.0.0)

Download OpenAPI specification:Download

Push data updates into Paystar via event-based integrations.

Push an event to Paystar

Submit an event to update data in Paystar. The payload field must be a serialized JSON string matching the schema for the given eventType.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
eventType
required
string
Enum: "Accounts.ManageCustomer" "Accounts.UnenrollAutopay"

The type of event being sent.

payload
required
string

A serialized JSON string containing the event-specific data. Must be valid JSON matching the schema for the specified eventType.

businessUnitSlug
required
string

The slug identifying the target business unit.

Responses

Request samples

Content type
application/json
{
  • "eventType": "Accounts.ManageCustomer",
  • "payload": "string",
  • "businessUnitSlug": "string"
}