Skip to main content
PUT
/
api
/
WebHooks
/
{webhookId}
Update a Web Hook.
curl --request PUT \
  --url https://api.example.com/api/WebHooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "events": [
    1
  ],
  "url": "<string>",
  "maxRetries": 50,
  "errorsNotificationMode": 0,
  "errorsEmailAddress": "<string>",
  "signingKey": "<string>",
  "isPaused": true
}
'
{
  "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "events": [
    1
  ],
  "url": "<string>",
  "maxRetries": 50,
  "errorsNotificationMode": 0,
  "errorsEmailAddress": "<string>",
  "signingKey": "<string>",
  "isPaused": true
}

Path Parameters

​
webhookId
string<uuid>
required

Body

application/json
​
name
string
required

Unique name for Integration Partner to identify Web Hook

Minimum string length: 1
​
events
enum<integer>[]
required

Array of events that will trigger this Web Hook

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
​
url
string
required

Target URL that Recruit Wizard will POST event notifications to

Minimum string length: 1
​
maxRetries
integer<int32>
required

Maximum Number of times we will attempt to send event notification

Required range: 0 <= x <= 100
​
errorsNotificationMode
enum<integer>
required
Available options:
0,
1,
2
​
errorsEmailAddress
string | null

Where we should send Error Notifications if we cannot POST data

​
signingKey
string | null

Webhook Signing Key

​
isPaused
boolean | null

Is Sending of Webhooks Paused?

Response

OK

​
webhookId
string<uuid>
required

Unique Identifer for Web Hook ( This is required to update Web Hook in subsequent requests )

​
createdDate
string<date-time>
required

Created Date ( UTC ) of Web Hook

​
updatedDate
string<date-time>
required

Most recent Update Date ( UTC ) of Web Hook

​
name
string
required

Unique name for Integration Partner to identify Web Hook

Minimum string length: 1
​
events
enum<integer>[]
required

Array of events that will trigger this Web Hook

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69
​
url
string
required

Target URL that Recruit Wizard will POST event notifications to

Minimum string length: 1
​
maxRetries
integer<int32>
required

Maximum Number of times we will attempt to send event notification

Required range: 0 <= x <= 100
​
errorsNotificationMode
enum<integer>
required
Available options:
0,
1,
2
​
errorsEmailAddress
string | null

Where we should send Error Notifications if we cannot POST data

​
signingKey
string | null

Webhook Signing Key

​
isPaused
boolean | null

Is Sending of Webhooks Paused?