Webhooks

Update a webhook

patch/webhooks/{id}

Request

  • Base URL: https://www.sociahive.com/api/v1
  • URL: https://www.sociahive.com/api/v1/webhooks/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • OAuth 2 (authorization code, authorization URL /api/oauth/authorize, token URL /api/oauth/token, scopes: webhooks:write)

Path parameters

idstring required

MongoDB ObjectId (24-character hex string)

Example:507f1f77bcf86cd799439011

Request body

target_urlstring uri
eventsWebhookEvent[]
account_idsstring[]

An empty list removes the limit.

activeboolean

Turning a webhook back on resets its failure count.

Example request

{
  "account_ids": [
    "507f1f77bcf86cd799439011"
  ]
}

Response

Updated

Example response

{
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "account_ids": [
      "507f1f77bcf86cd799439011"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.