Skip to content

Commit 2809706

Browse files
saitwilioSai Gattukdaswanimarkzegarelli
authored
Create Webhooks Actions docs (#3901)
* Create Webhooks Actions docs * Update getting started and remove sections * Add metadata Co-authored-by: Sai Gattu <[email protected]> Co-authored-by: kdaswani <[email protected]> Co-authored-by: markzegarelli <[email protected]>
1 parent 05aec83 commit 2809706

File tree

3 files changed

+162
-11
lines changed

3 files changed

+162
-11
lines changed

scripts/private-destination.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ const addPrivateDestination = async () => {
142142
message: 'Enter the destination ID'
143143
})
144144

145-
if (DEST_ID.id = '0') {
145+
if (DEST_ID.id == '0') {
146146
for (const element in ids) {
147147
let currentId = ids[element]
148148
await getDestinationData(currentId)

src/_data/catalog/destinations_private.yml

Lines changed: 131 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2022-12-01
2+
# destination data last updated 2022-12-06
33
items:
44
- id: 5f7dd8191ad74f868ab1fc48
55
display_name: Actions Pipedrive
@@ -1059,6 +1059,127 @@ items:
10591059
dynamic: false
10601060
allowNull: false
10611061
presets: []
1062+
- id: 614a3c7d791c91c41bae7599
1063+
display_name: Webhooks (Actions)
1064+
name: Webhooks (Actions)
1065+
slug: actions-webhook
1066+
previous_names:
1067+
- Webhook
1068+
- Webhooks (Actions)
1069+
website: https://segment.com/docs/integrations/actions-webhook
1070+
status: PRIVATE_BETA
1071+
logo:
1072+
url: https://cdn.filepicker.io/api/file/pN23yZ1Ro6L0I6YVGv3p
1073+
mark:
1074+
url: https://cdn.filepicker.io/api/file/8qGehdhwQy2Qbk6KNyhB
1075+
methods:
1076+
track: true
1077+
pageview: true
1078+
identify: true
1079+
group: true
1080+
alias: true
1081+
platforms:
1082+
browser: true
1083+
mobile: false
1084+
server: true
1085+
warehouse: true
1086+
components: []
1087+
browserUnbundlingSupported: false
1088+
browserUnbundlingPublic: false
1089+
replay: false
1090+
settings:
1091+
- name: sharedSecret
1092+
type: string
1093+
defaultValue: ''
1094+
description: >-
1095+
If set, Segment will sign requests with an HMAC in the "X-Signature"
1096+
request header. The HMAC is a hex-encoded SHA1 hash generated using
1097+
this shared secret and the request body.
1098+
required: false
1099+
label: Shared Secret
1100+
actions:
1101+
- id: nFPnRozhz1mh4Gbx4MLvT5
1102+
name: Send
1103+
slug: send
1104+
description: Send an HTTP request.
1105+
platform: CLOUD
1106+
hidden: false
1107+
defaultTrigger: null
1108+
fields:
1109+
- id: oXJmgujuaVydeMrki3gjjx
1110+
sortOrder: 0
1111+
fieldKey: url
1112+
label: URL
1113+
type: STRING
1114+
description: URL to deliver data to.
1115+
placeholder: ''
1116+
required: true
1117+
multiple: false
1118+
choices: null
1119+
dynamic: false
1120+
allowNull: false
1121+
- id: oAGqQ3FXatkbjSaBKUpar7
1122+
sortOrder: 1
1123+
fieldKey: method
1124+
label: Method
1125+
type: STRING
1126+
description: HTTP method to use.
1127+
placeholder: ''
1128+
defaultValue: POST
1129+
required: true
1130+
multiple: false
1131+
choices:
1132+
- label: POST
1133+
value: POST
1134+
- label: PUT
1135+
value: PUT
1136+
- label: PATCH
1137+
value: PATCH
1138+
- label: DELETE
1139+
value: DELETE
1140+
- label: GET
1141+
value: GET
1142+
dynamic: false
1143+
allowNull: false
1144+
- id: fZbrTu44jztYTDw8xqr5XU
1145+
sortOrder: 2
1146+
fieldKey: headers
1147+
label: Headers
1148+
type: OBJECT
1149+
description: HTTP headers to send with each request.
1150+
placeholder: ''
1151+
required: false
1152+
multiple: false
1153+
choices: null
1154+
dynamic: false
1155+
allowNull: false
1156+
- id: 6qaTt8XtG8dLBxtPTNbzRS
1157+
sortOrder: 3
1158+
fieldKey: data
1159+
label: Data
1160+
type: OBJECT
1161+
description: Payload to deliver to webhook URL (JSON-encoded).
1162+
placeholder: ''
1163+
defaultValue:
1164+
'@path': $.
1165+
required: false
1166+
multiple: false
1167+
choices: null
1168+
dynamic: false
1169+
allowNull: false
1170+
- id: 9dWmpRdaPnsGFu7Ycy3Fn1
1171+
sortOrder: 4
1172+
fieldKey: enable_batching
1173+
label: Enable Batching?
1174+
type: BOOLEAN
1175+
description: When enabled, Segment will send events in batches.
1176+
defaultValue: false
1177+
required: false
1178+
multiple: false
1179+
choices: null
1180+
dynamic: false
1181+
allowNull: false
1182+
presets: []
10621183
- id: 61d7456b078e79929de4ee8c
10631184
display_name: CleverTap (Actions)
10641185
name: CleverTap (Actions)
@@ -1123,7 +1244,7 @@ items:
11231244
hidden: false
11241245
defaultTrigger: null
11251246
fields:
1126-
- id: riruCuyy2tVDVz8XrawGjN
1247+
- id: jUHBqrL9tijh6a5DG1d7oQ
11271248
sortOrder: 0
11281249
fieldKey: ts
11291250
label: Created At
@@ -1137,7 +1258,7 @@ items:
11371258
choices: null
11381259
dynamic: false
11391260
allowNull: false
1140-
- id: tHVUT8H3vNkrfd7aJWxVzk
1261+
- id: fwc5YwWjXo67bCkoyHvaNj
11411262
sortOrder: 1
11421263
fieldKey: profileData
11431264
label: Person Attributes
@@ -1153,7 +1274,7 @@ items:
11531274
choices: null
11541275
dynamic: false
11551276
allowNull: false
1156-
- id: wVrVgyTGvrjD6VF7PGShw9
1277+
- id: x7jxiFBWUHN8frnVNE1hX1
11571278
sortOrder: 2
11581279
fieldKey: identity
11591280
label: Identity
@@ -1177,12 +1298,12 @@ items:
11771298
hidden: false
11781299
defaultTrigger: null
11791300
fields:
1180-
- id: xaSMDsUdxZ1KtoUZSoRic1
1301+
- id: mR7fVD9U5wQN2mmwLBTw9X
11811302
sortOrder: 0
11821303
fieldKey: identity
11831304
label: Identity
11841305
type: STRING
1185-
description: The ID used to uniquely identify a person in CleverTap
1306+
description: The ID of the profile which you want to delete
11861307
placeholder: ''
11871308
defaultValue:
11881309
'@path': $.userId
@@ -1390,7 +1511,7 @@ items:
13901511
browser: true
13911512
mobile: false
13921513
server: false
1393-
warehouse: true
1514+
warehouse: false
13941515
components: []
13951516
browserUnbundlingSupported: false
13961517
browserUnbundlingPublic: false
@@ -2110,7 +2231,7 @@ items:
21102231
browser: true
21112232
mobile: false
21122233
server: false
2113-
warehouse: true
2234+
warehouse: false
21142235
components: []
21152236
browserUnbundlingSupported: false
21162237
browserUnbundlingPublic: false
@@ -2220,7 +2341,7 @@ items:
22202341
browser: true
22212342
mobile: false
22222343
server: false
2223-
warehouse: true
2344+
warehouse: false
22242345
components: []
22252346
browserUnbundlingSupported: false
22262347
browserUnbundlingPublic: false
@@ -2296,7 +2417,7 @@ items:
22962417
browser: true
22972418
mobile: false
22982419
server: false
2299-
warehouse: true
2420+
warehouse: false
23002421
components: []
23012422
browserUnbundlingSupported: false
23022423
browserUnbundlingPublic: false
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Webhooks (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: false
5+
hidden: true
6+
private: true
7+
id: 614a3c7d791c91c41bae7599
8+
versions:
9+
- name: 'Webhooks (Classic)'
10+
link: '/docs/connections/destinations/catalog/webhooks'
11+
---
12+
13+
{% include content/plan-grid.md name="actions" %}
14+
15+
Segment's Webhooks (Actions) destination uses internet protocol and HTTP callback to submit real-time user data to your own HTTP endpoints. With this destination, you can POST, PUT, or PATCH data to any webhook URL.
16+
17+
> info ""
18+
> The Webhooks (Actions) destination is in beta and is in active development. Some functionality may change before it becomes generally available.
19+
20+
## Getting Started
21+
22+
1. From the Segment web app, navigate to **Connections > Catalog**.
23+
2. Search for **Webhooks (Actions)** in the Destinations Catalog, and select the destination.
24+
3. Click **Configure Webhooks (Actions)**.
25+
4. Select the source that will send data to Webhooks (Actions) and follow the steps to name your destination.
26+
5. If you require authentication, add in a shared secret on the **Settings** > **Advanced Settings** tab. If you provide a shared secret, Segment will sign requests with an HMAC in the "X-Signature" request header. The HMAC is a hex-encoded SHA1 hash generated using the shared secret and the request body.
27+
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You can create up to 5 mappings, each of which can send to a different webhook URL.
28+
7. Enable the destination and configured mappings.
29+
30+
{% include components/actions-fields.html settings="true"%}

0 commit comments

Comments
 (0)