# OpenAI batch finished notifications on your phone

> Get a push notification when an OpenAI Batch API job completes, fails, expires or is cancelled.

- Company: OpenAI (https://www.justpush.io/recipes/openai)
- Event: `batch.completed` (batch.completed, batch.failed, batch.expired and batch.cancelled)
- Tags: AI & LLMs, Cron & background jobs
- Install: https://studio.justpush.io/recipes/openai/batch
- Web page: https://www.justpush.io/recipes/openai/batch

## Setup

1. Click Install in Studio and sign in. The recipe is added to your account and you get a personal webhook URL.
2. In the OpenAI platform, open Settings > Project > Webhooks (platform.openai.com/settings/project/webhooks) and click Create.
3. Give the endpoint a name and paste your webhook URL (shown in Studio after install) as the URL.
4. Tick the batch.completed, batch.failed, batch.expired and batch.cancelled event types and save. Webhooks are per project, so repeat this for each project you want pushes from.
5. Tick **batch.completed**, **batch.failed**, **batch.expired** and **batch.cancelled** (or only the ones you want).
6. OpenAI's webhook only carries the batch ID, so the push says which batch finished and links to it in the dashboard. Download the results with `GET /v1/batches/{id}` and the Files API.
7. Only want to hear about problems? Add `?failures=1` to the URL and completed or cancelled batches stay quiet:
8. ```
9. your webhook URL (shown in Studio after install)?failures=1
10. ```
11. The **Send test event** option on the webhook page sends a sample event with a made-up ID (such as `batch_abc123`), so the button on that push won't find a batch.
12. OpenAI signs every delivery (Standard Webhooks: `webhook-id`, `webhook-timestamp`, `webhook-signature`), but JustPush doesn't check that signature yet, so keep your endpoint URL private.

## Code

Studio calls `handleRequest(request)` with the incoming webhook (`{ method, headers, body, query, raw }`) and sends the message object it returns. Returning `null` sends nothing.

```js
// OpenAI → batch.completed / batch.failed / batch.expired / batch.cancelled
// Fires when a Batch API job finishes, fails, runs past its completion window or is cancelled.
// Docs: https://developers.openai.com/api/reference/resources/webhooks
//
// OpenAI only sends the batch ID (data.id). The push links to the batch in the dashboard.

// Each event, how to word it, and how loud to be.
const EVENTS = {
    "batch.completed": {
        title: "✅ Batch completed",
        text: "finished. The output file is ready to download",
        priority: -1, // Low: good news you were waiting for
        failure: false,
    },
    "batch.expired": {
        title: "⏰ Batch expired",
        text: "didn't finish within its completion window. Check which requests completed",
        priority: 0, // Normal: partly done, worth a look
        failure: true,
    },
    "batch.failed": {
        title: "❌ Batch failed",
        text: "failed. Check the batch errors",
        priority: 1, // High: nothing got processed
        failure: true,
    },
    "batch.cancelled": {
        title: "🚫 Batch cancelled",
        text: "was cancelled",
        priority: -1, // Low: someone cancelled it on purpose
        failure: false,
    },
}

// Table lookup that ignores inherited names such as "toString".
function pick(table, key, fallback) {
    return typeof key === "string" && Object.prototype.hasOwnProperty.call(table, key) ? table[key] : fallback
}

// Only link to real http(s) URLs.
function link(url, cta) {
    return typeof url === "string" && /^https?:\/\//.test(url) ? [{ cta, url }] : []
}

// OpenAI IDs look like "batch_abc123"; anything else isn't used in text or links.
function cleanId(value) {
    return typeof value === "string" && /^[A-Za-z0-9_-]{1,128}$/.test(value) ? value : null
}

function handleRequest(request) {
    const body = request.body && typeof request.body === "object" ? request.body : {}
    const event = pick(EVENTS, body.type, null)

    // Guard: only batch events, so other OpenAI events on this integration stay quiet.
    if (!event) {
        console.log(`Ignoring OpenAI "${typeof body.type === "string" ? body.type : "unknown"}" event`)
        return null
    }

    // ?failures=1 on the webhook URL only pushes failed and expired batches.
    const failuresOnly = ["1", "true", "yes"].includes(String(request.query?.failures ?? "").toLowerCase())
    if (failuresOnly && !event.failure) {
        console.log(`Skipping ${body.type} (failures only)`)
        return null
    }

    const id = cleanId(body.data?.id)

    return {
        title: event.title,
        message: `${id ? `Batch ${id}` : "A batch"} ${event.text}.`,
        topic: "OpenAI",
        priority: event.priority,
        buttons: link(id ? `https://platform.openai.com/batches/${id}` : "https://platform.openai.com/batches", "View batch"),
    }
}
```

## OpenAI batch.completed webhook payload (sample)

```json
{
  "id": "evt_685343a1381c819085d44c354e1b330f",
  "data": {
    "id": "batch_abc123"
  },
  "type": "batch.completed",
  "object": "event",
  "created_at": 1790668800
}
```

## FAQ

### Does this work on iPhone and Android?

Yes. Install the JustPush app from the App Store or Google Play and sign in. Every phone signed in to your account gets the notification.

### Do I need to write code?

No. Install the recipe in Studio, paste your webhook URL into OpenAI and you are done. The code is there if you want to change the text, the sound or the buttons.

### Can I change what the notification says?

Yes. After install the recipe's code is yours. Edit it in Studio and test it against the sample payload before you save.

### What does it cost?

JustPush is free for 30 days. After that it's $19.99 a year, or $39.99 once. There is no extra charge for recipes.