search

pivotal-cf / docs-event-alerts

1 stars 2 forks source link

Clarify usage of webhooks in Event Alerts #33

Closed hillrw3 closed 5 years ago

hillrw3 commented 5 years ago

Signed-off-by: Glenn Oppegard goppegard@pivotal.io

cf-gitbot commented 5 years ago

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

jncd commented 5 years ago

Thanks @hillrw3 ! Merging now. We'll get in touch with questions... might you be available for a short pairing session later today?

jncd commented 5 years ago

Hi @hillrw3 and @oppegard Thanks again for this PR. We tidied up the PR a bit to conform with house style, etc. Take a look to make sure we haven't changed the meaning of anything. One question I have is about the difference between request body and request payload:

This means that the request body from Event Alerts will need to be transformed to a format compatible with the webhook receiver. For example, transforming from Event Alerts' JSON request payload (described below) to the format required for PagerDuty webhooks.

Is it trying to say that only the request body needs to be transformed but if you transform the whole payload then the body will get transformed too as part of the payload? Would it be okay to change request body to request payload?

Also, I'm cherry-picking this to master so it will appear in a v1.3 EVA too.

oppegard commented 5 years ago

Hi @jncd, request body and request payload are meant to signify the same things. For consistency, please feel free to change the usage of request body to request payload.

jncd commented 5 years ago

Thanks. Done!