SOsocket-dev
webhooks

Create a webhook

Changed on

Create a new webhook. Returns the created webhook details.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • webhooks:create
post/orgs/{org_slug}/webhooks

Request

  • Base URL
    https://api.socket.dev/v0
  • URL
    https://api.socket.dev/v0/orgs/{org_slug}/webhooks
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

org_slugstring required

The slug of the organization

Request body

namestring required

The name of the webhook

urlstring required

The URL where webhook events will be sent

secretstring required

The signing key used to sign webhook payloads

eventsstring[] required

Array of event names

descriptionstring nullable

The description of the webhook

headersobject nullable

Custom headers to include in webhook requests

Response

The created webhook

idstring required

The ID of the webhook

created_atstring required

The creation date of the webhook

updated_atstring required

The last update date of the webhook

namestring required

The name of the webhook

descriptionstring nullable required

The description of the webhook

urlstring required

The URL where webhook events will be sent

secretstring nullable required

The signing key used to sign webhook payloads

eventsstring[] required

Array of event names

headersobject nullable required

Custom headers to include in webhook requests

activeboolean required

Whether the webhook receives events. Inactive webhooks are skipped during delivery.

Changes