Webhooks

Update Webhook

Updates the requested webhook.

POST
/webhooks.update
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

action?webhooks-update-action

The action to update the webhook's status.

Value in"activate" | "deactivate"
event_types?webhooks-update-request-event-types
idstring

ID for the webhook.

Formatid
secret?string

If provided, updates the secret that's used when verifying webhook events, which must be between 8 and 32 bytes (inclusive). Otherwise if empty, then a new secret is generated. If the webhook is active, then its status will transition to the 'unverified' state and it won't receive any object events until successfully verified.

url?string

The webhook's updated URL. If the webhook is active, then the webhook's status will transition to the 'unverified' state and it won't receive any object events until successfully verified.

Formattext

Response Body

curl -X POST "https://api.devrev.ai/webhooks.update" \  -H "Content-Type: application/json" \  -d '{    "id": "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"  }'
{
  "webhook": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "event_types": [
      "account_created"
    ],
    "secret": "string",
    "status": "active",
    "url": "string"
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}