PUT
/
v1.0
/
{company_id}
/
webhooks
/
{webhook_id}
curl --request PUT \
  --url https://api.hirehive.com/v1.0/{company_id}/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoint": "<string>",
  "name": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "status": "enabled"
}'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "version": 123,
    "endpoint": "<string>",
    "description": "<string>",
    "signing_key": "<string>",
    "status": "enabled",
    "source": "dashboard",
    "subscribed_events": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
company_id
string
required
​
webhook_id
string
required

Body

application/json
​
endpoint
string
required
Minimum length: 1
​
name
string
required
Required string length: 1 - 250
​
events
string[]
required
​
status
enum<string>
required
Available options:
enabled,
disabled
​
description
string

Response

200
application/json
​
data
object

Was this page helpful?

Suggest editsRaise issue