Webhooks¶
Contains UP42 webhooks functionality to set up a custom callback e.g. when an order is finished he webhook is triggered and an event notification is transmitted via HTTPS to a specific URL.
Also see the full webhook documentation.
Create a new webhook or query a existing ones via the up42
object, e.g.
webhooks = up42.get_webhooks()
webhook = up42.initialize_webhook(webhook_id = "...")
The resulting Webhook object lets you modify, test or delete the specific webhook, e.g.
webhook = webhook.trigger_test_event()
Source code in up42/webhooks.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
Functions¶
create_webhook(name, url, events, active=False, secret=None)
¶
Registers a new webhook in the system.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
Webhook name |
required |
url |
str
|
Unique URL where the webhook will send the message (HTTPS required) |
required |
events |
List[str]
|
List of event types e.g. [order.status, job.status] |
required |
active |
bool
|
Webhook status. |
False
|
secret |
Optional[str]
|
String that acts as signature to the https request sent to the url. |
None
|
Returns:
Type | Description |
---|---|
Webhook
|
A dict with details of the registered webhook. |
Source code in up42/webhooks.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
get_webhook_events()
¶
Gets all available webhook events.
Returns:
Type | Description |
---|---|
dict
|
A dict of the available webhook events. |
Source code in up42/webhooks.py
128 129 130 131 132 133 134 135 136 137 |
|
get_webhooks(return_json=False)
¶
Gets all registered webhooks for this workspace.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
return_json |
bool
|
If true returns the webhooks information as JSON instead of webhook class objects. |
False
|
Returns:
Type | Description |
---|---|
List[Webhook]
|
A list of the registered webhooks for this workspace. |
Source code in up42/webhooks.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
Webhook¶
Webhook class to control a specific UP42 webhook, e.g. modify, test or delete the specific webhook.
webhook = webhook.trigger_test_event()
Source code in up42/webhooks.py
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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
|
Attributes¶
info: dict
property
¶
Gets and updates the webhook metadata information.
Functions¶
delete()
¶
Deletes a registered webhook.
Source code in up42/webhooks.py
94 95 96 97 98 99 100 |
|
trigger_test_events()
¶
Triggers webhook test event to test your receiving side. The UP42 server will send test messages for each subscribed event to the specified webhook URL.
Returns:
Type | Description |
---|---|
dict
|
A dict with information about the test events. |
Source code in up42/webhooks.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
update(name=None, url=None, events=None, active=None, secret=None)
¶
Updates a registered webhook.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
Optional[str]
|
Updated webhook name |
None
|
url |
Optional[str]
|
Updated unique URL where the webhook will send the message (HTTPS required) |
None
|
events |
Optional[List[str]]
|
Updated list of event types [order.status, job.status]. |
None
|
active |
Optional[bool]
|
Updated webhook status. |
None
|
secret |
Optional[str]
|
Updated string that acts as signature to the https request sent to the url. |
None
|
Returns:
Type | Description |
---|---|
Webhook
|
The updated webhook object. |
Source code in up42/webhooks.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
|