SOsocket-dev
webhooks

Update webhook

Changed on

Update details of an existing webhook.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • webhooks:update
put/orgs/{org_slug}/webhooks/{webhook_id}

Request

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

Path parameters

org_slugstring required

The slug of the organization

webhook_idstring required

The ID of the webhook

Request body

namestring

The name of the webhook

descriptionstring nullable

The description of the webhook

urlstring

The URL where webhook events will be sent

secretstring nullable

The signing key used to sign webhook payloads

eventsstring[]

Array of event names

headersobject nullable

Custom headers to include in webhook requests

activeboolean

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

Response

Updated webhook details

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

  • 5ad8bf36b1e7Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status