Register a New Service Hook

POST /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/

Register a new service hook on a project.

Events include:

  • event.alert: An alert is generated for an event (via rules).
  • event.created: A new event has been processed.

This endpoint requires the 'servicehooks' feature to be enabled for your project.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The id or slug of the organization the client keys belong to.

project_id_or_slug (string)
REQUIRED

The id or slug of the project the client keys belong to.

Body Parameters

url (string)
REQUIRED

The URL for the webhook.

events (array(string))
REQUIRED

The events to subscribe to.

Scopes

<auth_token> requires one of the following scopes:
  • project:write
curl https://sentry.io/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{"url":"https://empowerplant.io/sentry-hook","events":["event.alert","event.created"]}'
RESPONSESCHEMA
{
  "dateCreated": "2018-11-06T21:20:08.143Z",
  "events": [
    "event.alert",
    "event.created"
  ],
  "id": "4f9d73e63b7144ecb8944c41620a090b",
  "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2",
  "status": "active",
  "url": "https://empowerplant.io/sentry-hook"
}