Introduction to Support Ticket Webhooks
Support tickets are processed asynchronously: when you create one via Create Support Ticket, the API responds immediately with202 Accepted and the ticket is registered with Ripio’s support team in the background. Subscribing to these webhook events is the recommended way to learn the outcome — your application is notified automatically as soon as the ticket reaches the CREATED or FAILED status, with no need to call the Retrieve Support Ticket endpoint.
Support tickets — and therefore these webhook events — are an opt-in feature that must be enabled for your account by the Ripio team. Contact the Ripio team to have support tickets enabled.
These events report only the ticket’s registration outcome —
CREATED means it was successfully registered with Ripio’s support team, not that it has been resolved. From that point on, all follow-up with the end user happens over email, directly between Ripio’s support team and the customer (using the customer’s email address). The conversation and resolution are not delivered through these webhooks. See Create Support Ticket for details.Event Payload Structure
Each Support Ticket event notification contains a JSON-formatted payload with the following top-level structure:eventType(String): The specific type of Support Ticket event that occurred, following the formatSUPPORT_TICKET.<STATUS>.issueDatetime(String): UTC timestamp indicating when the event was triggered.supportTicket(Object): An object containing details of the support ticket associated with the event.
Support Ticket Event Types
SUPPORT_TICKET.CREATED
- Description: Sent when a support ticket has been successfully registered with Ripio’s support team. The
issueKeyreference is now available. supportTicketobject includes:
SUPPORT_TICKET.FAILED
- Description: Sent when a support ticket could not be registered with Ripio’s support team. The
issueKeyisnull. You may retry by creating a new ticket. supportTicketobject includes:
Payload fields
ThesupportTicket object contains the following fields:
ticketId(String, UUID): Ripio’s identifier for the support ticket, as returned by the Create Support Ticket endpoint.customerId(String, UUID): Your customer ID for the end user the ticket was raised on behalf of.issueKey(String, nullable): Human-readable reference of the ticket in Ripio’s support system (e.g.SUP-1234). Populated forSUPPORT_TICKET.CREATED;nullforSUPPORT_TICKET.FAILED.summary(String): The summary you provided when creating the ticket.status(String): The ticket status —CREATEDorFAILED.