diff --git a/docs/index.md b/docs/index.md index 138beddc6..5fa2109d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,7 +48,7 @@ To get started: Integrate the GOV.UK Notify API into your service =================================================== -GOV.UK.Notify provides an API that allows you to create text and email notifications and get the status of notifications you have sent. +GOV.UK Notify provides an API that allows you to create text and email notifications and get the status of notifications you have sent. API integration ------------------ @@ -59,7 +59,7 @@ There are two ways to integrate the API into your service: * use a client library provided by GOV.UK Notify - there is currently a [python library](https://github.com/alphagov/notifications-python-client) and more will be added in different languages * develop your own integration to produce requests in the correct format -GOV.UK.Notify uses [JWT tokens](https://jwt.io/) for authentication and identification. JWT tokens are built into the GOV.UK Notify client library. If you don't use this library, you must manually create tokens yourself. +GOV.UK Notify uses [JWT tokens](https://jwt.io/) for authentication and identification. JWT tokens are built into the GOV.UK Notify client library. If you don't use this library, you must manually create tokens yourself. A JWT token contains, in encrypted format: * your service ID - identifies your service @@ -155,9 +155,9 @@ POST /notifications/email ``` where: -* 'to' is the phone number (required) -* ‘template’ is the template ID to send (required) -* ‘personalisation‘ (optional) specifies the replaceables [where do these come from, the csv file?] +* `to` is the phone number (required) +* `template` is the template ID to send (required) +* `personalisation` (optional) specifies the replaceables [where do these come from, the csv file?] The response will be: @@ -194,11 +194,11 @@ GET /notifications/{id} } ``` where: -* ‘status’ is the the status of the notification; this can be 'sending', 'delivered', 'failed' [change status in message above?] -* 'method' is 'sms' or 'email' -* 'job_id' is the unique identifier for the process of sending [change to retrieving?] the notification -* 'message' is the content of message -* 'sender' may be the provider [?] +* `status` is the the status of the notification; this can be `sending`, `delivered`, `failed` [change status in message above?] +* `method` is `sms` or `email` +* `job_id` is the unique identifier for the process of sending [change to retrieving?] the notification +* `message` is the content of message +* `sender` may be the provider [?] The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above.