Register a new Service Hook

POST /api/0/projects/{organization_slug}/{project_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_slug (string)

    the slug of the organization the client keys belong to.

  • project_slug (string)

    the slug of the project the client keys belong to.

Parameters:
  • url (string)

    the url for the webhook

  • events (array[string])

    the events to subscribe to

Authentication: required
Method: POST
Path: /api/0/projects/{organization_slug}/{project_slug}/hooks/

Example

POST /api/0/projects/the-interstellar-jurisdiction/pump-station/hooks/ HTTP/1.1
Host: sentry.io
Authorization: Bearer <token>
Content-Type: application/json

{
  "events": [
    "event.alert", 
    "event.created"
  ], 
  "url": "https://example.com/sentry-hook"
}
HTTP/1.1 201 CREATED
Content-Length: 269
X-XSS-Protection: 1; mode=block
Content-Language: en
X-Content-Type-Options: nosniff
Vary: Accept-Language, Cookie
Allow: GET, POST, HEAD, OPTIONS
X-Frame-Options: deny
Content-Type: application/json

{
  "dateCreated": "2018-11-06T21:20:08.143Z", 
  "events": [
    "event.alert", 
    "event.created"
  ], 
  "id": "4f9d73e63b7144ecb8944c41620a090b", 
  "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2", 
  "status": "active", 
  "url": "https://example.com/sentry-hook"
}