Mark Event Delivered

Mark an event as delivered after processing.

Endpoint

PATCH /partner/v1/events/{id}

Request

Path parameters

Name	Type	Required	Description
id	string (UUID)	Yes	Event ID to mark as delivered

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key

Response

Success (200 OK)

{}

Not found (404 Not Found)

The event was not found or does not belong to your partner account.

Example

curl -X PATCH https://api.bipa.tech/partner/v1/events/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: your_partner_api_key"

Usage pattern

A typical event processing flow:

1. Poll for pending events using GET /partner/v1/events?delivered=false
2. Process each event in your system
3. Mark each event as delivered using this endpoint
4. Repeat periodically

async function processEvents() {
  // 1. Fetch pending events
  const response = await fetch(
    "https://api.bipa.tech/partner/v1/events?delivered=false",
    { headers: { "X-API-Key": process.env.BIPA_PARTNER_API_KEY } }
  );
  const { events } = await response.json();

  // 2. Process each event
  for (const event of events) {
    await handleEvent(event);

    // 3. Mark as delivered
    await fetch(
      `https://api.bipa.tech/partner/v1/events/${event.id}`,
      {
        method: "PATCH",
        headers: { "X-API-Key": process.env.BIPA_PARTNER_API_KEY }
      }
    );
  }
}