Events

Events represent actions that occur in your connected integrations, such as a new GitHub pull request, a Slack message, or a Jira issue update. Use the Events API to query historical events or inspect a specific event in detail.

---

List Events

Returns a paginated, filterable list of events for a workspace.

curl -G https://api.moonshadow.dev/v1/workspaces/ws_abc123/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "type=pull_request" \
  -d "source=github" \
  -d "since=2024-06-01T00:00:00Z" \
  -d "limit=10"

Path Parameters

id · string · required

The workspace ID to query events for.

Query Parameters

type · string

Filter by event type, e.g. pull_request, message, issue.

source · string

Filter by integration source, e.g. github, slack, jira.

since · string

ISO 8601 timestamp. Only return events created after this time.

limit · integer · default: "20"

Maximum number of events to return. Maximum is 100.

cursor · string

Cursor from a previous response to fetch the next page.

Response

data · array

Array of event objects.

data[].event_id · string

Unique event identifier, e.g. evt_mno345.

data[].type · string

Event type, e.g. pull_request, message, issue.

data[].source · string

Integration source that fired the event.

data[].payload · object

Provider-specific event payload.

data[].created_at · string

ISO 8601 timestamp of when the event was received.

pagination · object

Cursor pagination metadata.

{
  "data": [
    {
      "event_id": "evt_mno345",
      "type": "pull_request",
      "source": "github",
      "payload": {
        "action": "opened",
        "number": 42,
        "repository": "acme/app",
        "title": "Add user authentication flow",
        "author": "alice"
      },
      "created_at": "2024-06-10T14:30:00Z"
    },
    {
      "event_id": "evt_pqr678",
      "type": "message",
      "source": "slack",
      "payload": {
        "channel": "#engineering",
        "user": "bob",
        "text": "Deployment to production is complete."
      },
      "created_at": "2024-06-10T14:25:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6ImV2dF9wcXI2NzgifQ==",
    "has_more": true
  }
}

---

Get an Event

Retrieves a single event by its ID.

curl https://api.moonshadow.dev/v1/workspaces/ws_abc123/events/evt_mno345 \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id · string · required

The workspace ID.

eventId · string · required

The event ID to retrieve.

Response

{
  "event_id": "evt_mno345",
  "type": "pull_request",
  "source": "github",
  "payload": {
    "action": "opened",
    "number": 42,
    "repository": "acme/app",
    "title": "Add user authentication flow",
    "author": "alice",
    "url": "https://github.com/acme/app/pull/42"
  },
  "created_at": "2024-06-10T14:30:00Z"
}

Event Object Shape

Every event shares the following fields:

event_id · string

Unique identifier for the event.

type · string

Category of the event. Common values: pull_request, push, message, issue, commit.

source · string

Name of the integration that produced the event.

payload · object

Raw data from the provider. The structure varies by type and source.

created_at · string

ISO 8601 timestamp when Moonshadow received the event.

Filter Examples

Filter by event type only

curl -G https://api.moonshadow.dev/v1/workspaces/ws_abc123/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "type=issue"

Filter by source and time range

curl -G https://api.moonshadow.dev/v1/workspaces/ws_abc123/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "source=slack" \
  -d "since=2024-06-08T00:00:00Z"

Fetch a large batch with pagination

curl -G https://api.moonshadow.dev/v1/workspaces/ws_abc123/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "limit=100"

Then use the next_cursor from the response on subsequent requests:

curl -G https://api.moonshadow.dev/v1/workspaces/ws_abc123/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "limit=100" \
  -d "cursor=eyJpZCI6ImV2dF9wcXI2NzgifQ=="

Filtering and Webhooks

For real-time event delivery, you can subscribe to webhooks instead of polling the Events API. See the Webhooks Guide for setup instructions.