Skip to main content

Events API

POST /v1/projects/:id/events/:eid/replay

Replay an existing event by re-queuing it for delivery to all linked destinations.

Authentication

Requires JWT. The authenticated user must own the project.

Path Parameters

ParameterTypeDescription
idUUIDProject ID
eidUUIDEvent ID

Response

200 OK

{
"message": "event replayed",
"destinations": 3
}

Error Responses

StatusDescription
400 Bad RequestInvalid project or event ID format
404 Not FoundProject or event not found
500 Internal Server ErrorFailed to fetch destinations
503 Service UnavailableDelivery queue unavailable

Behavior

  • Uses the current endpoint-destination configuration (templates, transforms, routing rules)
  • Creates new delivery attempts — does not modify existing ones
  • The original event payload is used (transforms are re-applied at delivery time)

POST /v1/projects/:id/sources/:eid/test

Send a synthetic test event through an endpoint.

Authentication

Requires JWT. The authenticated user must own the project. The endpoint must belong to the project.

Path Parameters

ParameterTypeDescription
idUUIDProject ID
eidUUIDEndpoint ID

Request Body (Optional)

{
"payload": {
"action": "test",
"repository": {
"full_name": "owner/repo"
}
}
}

If no payload is provided, a default is used:

{
"test": true,
"message": "Hello from Dispatch!"
}

Response

202 Accepted

{
"event_id": "550e8400-e29b-41d4-a716-446655440000",
"destinations": 2
}

Behavior

  • Creates a real event with event_type = "test"
  • Event is stored and processed normally
  • Delivery is attempted to all active linked destinations
  • Useful for testing templates, transforms, and destination connectivity