# opbeat-http-client

> An HTTP client for communicating with the Opbeat intake API

Latest version **1.2.2** (published 2017-01-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install opbeat-http-client
pnpm add opbeat-http-client
yarn add opbeat-http-client
bun add opbeat-http-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2017-01-16 |
| First published | 2015-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Thomas Watson Steen |
| Maintainers | watson |
| Keywords | opbeat, http, client |

## Links

- npm: https://www.npmjs.com/package/opbeat-http-client
- Repository: https://github.com/watson/opbeat-http-client
- Issues: https://github.com/watson/opbeat-http-client/issues
- npm.io page: https://npm.io/package/opbeat-http-client

## Dependencies (1)

- [fast-safe-stringify](https://npm.io/package/fast-safe-stringify.md) ^1.1.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2017-01-16
- 1.2.1 — 2017-01-16
- 1.2.0 — 2016-08-25
- 1.1.0 — 2016-08-24
- 1.0.3 — 2015-04-24
- 1.0.2 — 2015-03-14
- 1.0.1 — 2015-03-14
- 1.0.0 — 2015-03-13

## README

# opbeat-http-client

[![Build status](https://travis-ci.org/watson/opbeat-http-client.svg?branch=master)](https://travis-ci.org/watson/opbeat-http-client)

[![js-standard-style](https://raw.githubusercontent.com/feross/standard/master/badge.png)](https://github.com/feross/standard)

A low-level HTTP client for communicating with the Opbeat intake API.

This module is meant for building other modules that needs to
communicate with Opbeat.

If you are looking to use Opbeat in your app or website, you'd most
likely want to check out [the official Opbeat module for
Node.js](https://github.com/opbeat/opbeat-node) instead.

## Installation

```
npm install opbeat-http-client
```

## Example Usage

```js
var opbeatHttpClient = require('opbeat-http-client')({
  appId: '...',
  organizationId: '...',
  secretToken: '...',
  userAgent: '...'
})

opbeatHttpClient.request('errors', body, function (err, res, body) {
  if (err) throw err
  console.log(body)
})
```

## API

The module exposes an initialize function which takes a single options
hash as the 1st argument. All properties are required:

- `appId` - The Opbeat app id
- `organizationId` - The Opbeat organization id
- `secretToken` - The Opbeat secret token
- `userAgent` - The HTTP user agent that your module should identify it
  self with

The init function will return a low level HTTP client primed for
communicating with the Opbeat intake API.

### `client.request(endpoint, [headers], body, callback)`

#### endpoint

The Opbeat intake API v1 currently support the following two endpoints:

- `errors`
- `releases`

The full URL's for those are:

```
https://intake.opbeat.com/api/v1/organizations/<organization-id>/apps/<app-id>/<endpoint>/
```

When specifying the `endpoint` argument in the `client.request()`
method, you just have to specify that last part of the URL, e.g.
"releases".

#### headers

An optional object that you can use to supply custom headers that should
be sent to the Opbeat intake API.

#### body

The body should be in the form of a JavaScript object literal. The
opbeat-http-client will take care of encoding it correctly.

#### callback

The callback function is called with 3 arguments:

1. An error when applicable (usually from the [http.ClientRequest](https://nodejs.org/api/http.html#http_class_http_clientrequest) object)
1. An [http.IncomingMessage](https://nodejs.org/api/http.html#http_http_incomingmessage) object
1. The response body (as a String)

## License

MIT

---
_Source: https://npm.io/package/opbeat-http-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._