Skip to content

Commit 3405ece

Browse files
committed
testing
1 parent 7d03a85 commit 3405ece

File tree

1 file changed

+3
-52
lines changed

1 file changed

+3
-52
lines changed

src/pages/guides/index.md

Lines changed: 3 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ With Adobe I/O Events webhooks, your application can sign up to be notified when
1818
For example, when a user uploads a asset, this action generates an event.
1919
With the right webhook in place, your application is instantly notified that this event happened.
2020

21-
Please refer to the `Adobe Developer Console` documentation on how to [Add Events to a project](/developer-console/docs/guides/services/services-add-event/)
21+
Please refer to the `Adobe Developer Console` documentation on how to [Add Events to a project](https://developer.adobe.com/developer-console/docs/guides/services/services-add-event/)
2222

2323
To start receiving events, you create an event registration specifying a webhook URL and the types of events you want to receive. Each event will result in a HTTP request to the given URL, notifying your application. This guide provides an introduction to webhooks.
2424

@@ -162,55 +162,6 @@ Your webhook must respond to the POST request with an HTTP status code of 200 be
162162

163163
<InlineAlert slots="text"/>
164164

165-
Please note that for **security** reasons we **obfuscate** the validation URL in the [debug tracing](/support/tracing/) tab.
165+
Please note that for **security** reasons we **obfuscate** the validation URL in the [debug tracing](../support/tracing.md) tab.
166166
So, the only way to intercept the original validation URL is if you own the webhook server (*you could simply log all requests*).<br/>
167-
![Validation URL obfuscated in Debug Tracing tab](/img/debug_tracing_challenge_post_obfuscated.png "Validation URL obfuscated in Debug Tracing tab")
168-
169-
### Testing with ngrok
170-
171-
[Ngrok](https://ngrok.com/) is a utility for enabling secure introspectable tunnels to your localhost. With ngrok, you can securely expose a local web server to the internet and run your own personal web services from your own machine, safely encrypted behind your local NAT or firewall. With ngrok, you can iterate quickly without redeploying your app or affecting your customers.
172-
173-
Among other things, ngrok is a great tool for testing webhooks. Once you've downloaded and installed [ngrok](https://ngrok.com/), you run it from a command line, specifying the protocol and port you want to monitor:
174-
175-
```bash
176-
ngrok http 80
177-
```
178-
179-
![ngrok on port 80](/img/ngrok.png "ngrok on port 80")
180-
181-
In the ngrok UI, you can see the URL for viewing the ngrok logs, labeled "Web Interface", plus the public-facing URLs ngrok generates to forward HTTP and HTTPS traffic to your localhost. You can use either of those public-facing URLs to register your Webhook with Adobe I/O, so long as your application is configured to respond on your localhost accordingly. Once your testing phase is complete, you can replace the ngrok URL in your Adobe I/O integration with the public URL for your deployed app.
182-
183-
## Create a project in the `Adobe Developer Console`
184-
185-
Integrations are now created as part of a project within the `Adobe Developer Console`. This requires you to have access to the [Console](https://www.adobe.com/go/devs_console_ui) in order to create a project, add events to your project, configure the events, and register your webhook.
186-
187-
For detailed instructions on completing these steps, please begin by reading the [`Adobe Developer Console` Getting Started guide](https://www.adobe.com/go/devs_console_getting_started).
188-
189-
Once you have completed the event registration, check the ngrok log. You should see a `GET` request, including the `challenge` that was passed along in the URL.
190-
191-
![The challenge GET request received in ngrok](/img/ngrok_2.png "The challenge GET request received in ngrok")
192-
193-
In the `Adobe Developer Console`, you will be taken to the *Registration Details* page once the event registration is complete.
194-
195-
The *Status* of the registration should show as **Active**. If the registration shows as **Disabled** please see the [troubleshooting](#troubleshooting-a-disabled-registration-status) section that follows.
196-
197-
![Event Registration Details tab in Adobe Developer Console](/img/events-registration-details.png "Event Registration Details tab in Adobe Developer Console")
198-
199-
### Troubleshooting Unstable/Disabled Registration Status
200-
201-
If you made an error transcribing the webhook URL, Adobe I/O Events' test of your webhook would have failed, resulting in a **Disabled** status.
202-
203-
In general, `Adobe I/O Events` will always confirm that your webhook received an event by means of the response code your webhook sends to each HTTP POST request.
204-
205-
<RetryDoc/>
206-
207-
To restart the flow of requests, fix the problem preventing your webhook from responding. Then, log into the `Adobe Developer Console` and edit your events registration. This re-triggers a webhook challenge request, and eventually a re-activation of your event registration.
208-
209-
Note: While your event registration is marked `Disabled`, Adobe will continue to log events in your Journal, allowing you to retrieve all events for the past 7 days (see our [Journaling documentation](journaling-intro.md)).
210-
211-
*Unstable Event Registration*
212-
![Unstable Status](/img/unstable-status.png "Example of an Unstable event registration")
213-
214-
*Disabled Event Registration*
215-
![Disabled Status](/img/disabled-status.png "Example of a Disabled event registration")
216-
167+
![Validation URL obfuscated in Debug Tracing tab](/img/debug_tracing_challenge_post_obfuscated.png)

0 commit comments

Comments
 (0)