What is the structure of webhook request?

muthusk · January 26, 2016, 9:46pm

How does a webhook http request look like? Can an example for rate limit or quota limit be posted here ?
Would it have the api id?or just the path?
If below is the default template it doesnt have API_ID.
{
“event”: “{{.EventType}}”,
“message”: “{{.EventMetaData.Message}}”,
“path”: “{{.EventMetaData.Path}}”,
“origin”: “{{.EventMetaData.Origin}}”,
“key”: “{{.EventMetaData.Key}}”
}

if “{{.EventMetaData.APIID}}”, added to it, will it be available on the webhook calls for Rate limit / quotalimit/ key expiry / authentication events?

Martin · January 26, 2016, 10:40pm

The event objects are all here:

github.com

TykTechnologies/tyk/blob/dd8e29f1ddd44646f54b9013e5c3f845687ce8ed/event_system.go#L48


      
          	Message            string
          	OriginatingRequest string
          }
          
          
type EVENT_HostStatusMeta struct {
          	EventMetaDefault
          	HostInfo HostHealthReport
          }
          
          
// EVENT_QuotaExceededMeta is the metadata structure for a quota exceeded event (EVENT_QuotaExceeded)
          type EVENT_QuotaExceededMeta struct {
          	EventMetaDefault
          	Path   string
          	Origin string
          	Key    string
          }
          
          
// EVENT_RateLimitExceededMeta is the metadata structure for a rate limit exceeded event (EVENT_RateLimitExceeded)
          type EVENT_RateLimitExceededMeta struct {
          	EventMetaDefault
          	Path   string

They would need to be extended to include API ID, and in turn, the firing event source would need to populate the field.

Once added, they would be in the template too.

muthusk · January 28, 2016, 5:09pm

Thanks Martin.
Prefer to stay on distributed version / docker containers released. Currently as a work around, have configured multiple webhooks for each API’s events and API ID as hard coded additional header.
Can this be considered for future release?

Martin · January 28, 2016, 5:22pm

Sure, want to put a post into the feature requests topic?