Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stympy authored and mdg committed Aug 29, 2024
1 parent 584e24b commit dd49188
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,29 @@ Honeybadger.add_breadcrumb("Email sent", metadata: %{

---

### `Honeybadger.event`: Send an event to Honeybadger Insights.

Use the `Honeybadger.event/1` function to send event data to the events API. A
`ts` field with the current timestamp will be added to the data if it isn't
provided. You can also use `Honeybadger.event/2`, which accepts a string as the
first parameter and adds that value to the `event_type` field in the map before
being sent to the API.

#### Examples:

```elixir
Honeybadger.event(%{
event_type: "user_created",
user: user.id
})

Honeybadger.event("project_deleted", %{
project: project.name
})
```

---

## Proxy configuration

If your server needs a proxy to access Honeybadger, add the following to your config
Expand Down Expand Up @@ -427,7 +450,7 @@ will be accepted.

#### Github Workflow

A new version can be published on Hex.pm using the Publish New Release workflow.
A new version can be published on Hex.pm using the Publish New Release workflow.
The workflow can be triggered manually from the Github Actions page and takes the following input:
- `version`: One of `patch`, `minor` or `major`. The version number will be bumped accordingly.
- `changes`: An entry to be added to the changelog.
Expand Down

0 comments on commit dd49188

Please sign in to comment.