Webhook¶
Many SaaS applications have implemented Webhooks and enable users to receive a notification at a user-specified destination when a specific event occurs.
Ingesting data over HTTP¶
Depending on SaaS applications, you may need a different authentication.
Bearer token¶
You can use your Observe token as a bearer token in the authorization header.
https://${OBSERVE_CUSTOMER?}.collect.observeinc.com/v1/http/{path} -H Authorization:"Bearer ${OBSERVE_TOKEN?}"
For example, your HTTP request may have the following format:
https://123456789012.collect.observeinc.com/v1/http/webhook-example -H Authorization:"Bearer ab1cdE2FGhiJKlmnop34Q:rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr"
Basic authentication¶
Most tools that support basic authentication expect the username and password to be separated by a single colon, :
. In such cases, you can reference the Observe token directly, for example:
https://${OBSERVE_CUSTOMER?}.collect.observeinc.com/v1/http/{path} --user ${OBSERVE_TOKEN}
In this case, your HTTP request may have the following format:
https://123456789012.collect.observeinc.com/v1/http/webhook-example --user ab1cdE2FGhiJKlmnop34Q:rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr
If a Webhook form requires a separate user and a password, then use the following format:
https://${OBSERVE_CUSTOMER?}.collect.observeinc.com/v1/http/{path} --user ${OBSERVE_DATASTREAM_TOKEN} --password ${OBSERVE_DATASTREAM_SECRET}
In this case, your HTTP request may have the following format:
https://123456789012.collect.observeinc.com/v1/http/webhook-example --user ab1cdE2FGhiJKlmnop34Q --password rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr
Alternatively, you can embed the token directly in the URL:
https://${OBSERVE_TOKEN}@${OBSERVE_CUSTOMER?}.collect.observeinc.com/v1/http/{path}
In this case, your HTTP request may have the following format:
https://ab1cdE2FGhiJKlmnop34Q:rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr@123456789012.collect.observeinc.com/v1/http/webhook-example
Query parameter¶
Some clients do not support configuring HTTP headers or configuring basic authentication. In this case, you can embed the token as a query parameter:
https://${OBSERVE_CUSTOMER?}.collect.observeinc.com/v1/http/{path}?observe_token=${OBSERVE_TOKEN?}
In this case, your query parameter may have the following format:
https://123456789012.collect.observeinc.com/v1/http/webhook-example?observe_token=ab1cdE2FGhiJKlmnop34Q:rstUv5w6Xy7z8AB_CdeFg9h0iJK1mnOPqr
For more examples of configuring Webhooks, see Shared Action Integrations.