HOhoneybadger
Projects

Create a project

Creates a new project in the account.

post/projects

Request

Request body

namestring required

Project name

resolve_errors_on_deployboolean nullable

Resolve every open fault when a deploy is recorded. Null resets it to true.

disable_public_linksboolean nullable

Disallow shareable public fault links. Null resets it to false.

languagestring nullable

Primary language, used to format backtraces. Null clears it.

user_urlstring nullable

Template for linking a fault's affected user into your own system. [user_id] and [user_email] are substituted. Null clears it.

source_urlstring nullable

Template for linking a backtrace line to your source host. [file] and [line] are substituted. Null clears it.

user_search_fieldstring nullable

Context key identifying the affected user, for when it is not in the default context.user_email or context.user_id. Null clears it.

asana_workspace_idstring nullable

Asana workspace used by the project's Asana integration. Null clears it.

customer_throttleinteger nullable

Notices accepted per minute before throttling kicks in. Null clears it.

purge_daysinteger nullable

Days to retain notices. Changing it requires custom retention on the account; without it, only the current value (on create, the default) is accepted. Null clears it.

disable_email_notificationsboolean

Create-only. Members added with the project get email notifications switched off. Not stored or returned.

team_idstring

Puts the new project in this team. Create-only: afterwards the team's project_ids owns membership. Including it requires team:write in addition to the operation's project scope, and the user must be allowed to manage the team. Without team:write the entire request is rejected with 403 insufficient_scope; no other fields are saved.

Example request

{
  "name": "Billing API",
  "language": "ruby",
  "user_url": "https://admin.example.com/users/[user_id]",
  "source_url": "https://github.com/acme/app/blob/main/[file]#L[line]",
  "user_search_field": "context.account_id",
  "team_id": "Ab3kL9"
}

Response

Project created

Example response

{
  "data": {
    "id": "Xk9mZp",
    "account_id": "Ab3kL9",
    "name": "My Rails App",
    "environments": [
      "production",
      "staging",
      "development"
    ],
    "user_url": "https://admin.example.com/users/[user_id]",
    "source_url": "https://github.com/acme/app/blob/main/[file]#L[line]",
    "user_search_field": "context.account_id",
    "language": "Ruby",
    "fault_count": 128,
    "unresolved_fault_count": 12,
    "purge_days": 90,
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.