Content
dispatch.all.readdispatch.all.readwrite
Find all Domains.
pageToken | Optional | string | Specifies the page to read. Use a value provided by earlier responses in Example: |
limit | Optional | integer 1 - 100 (Default: 50) | Limit the return page size to the specified count. Example: |
200 | application/json | |
Example response body{ "count": 1, "pageToken": "eyJmaXJzdCI6InBhZ2UifQ==", "nextPageToken": "eyJzZWNvbmQiOiJwYWdlIn0=", "items": [ { "id": "DI-D-3f0d067002", "domainName": "www.example.com", "verificationCode": "0adb28c65ae14a1586a8e98525bb0896", "verificationStatus": "VERIFIED", "createdAt": "2020-04-26T09:44:23.065Z" } ] } | ||
<< | No Content | |
dispatch.all.readwrite
Add a Domain. Domains need to be verified in order to be used by webhook targets.
domainName | Required | string | The name of the Domain Example: |
200 | application/json | A Domain |
Example response body{ "id": "DI-D-3f0d067002,", "domainName": "www.example.com,", "verificationCode": "0adb28c65ae14a1586a8e98525bb0896,", "verificationStatus": "NOT_VERIFIED", "createdAt": "2020-04-26T09:44:23.065Z" } | ||
<< | No Content | |
E-DI-4002 | Domain name already in use |
dispatch.all.readdispatch.all.readwrite
domainId | string | A Domain ID Example: |
200 | application/json | A Domain |
Example response body{ "id": "DI-D-3f0d067002,", "domainName": "www.example.com,", "verificationCode": "0adb28c65ae14a1586a8e98525bb0896,", "verificationStatus": "VERIFIED", "createdAt": "2020-04-26T09:44:23.065Z" } | ||
404 | No Content | The Domain was not found. |
<< | No Content | |
dispatch.all.readwrite
Verify the ownership of a domain Domain. You can read more about the domain verification process in Configuring Webhook targets.
domainId | string | A Domain ID Example: |
200 | application/json | The Domain was verified sucessfully |
Example response body{ "id": "DI-D-3f0d067002,", "domainName": "www.example.com,", "verificationCode": "0adb28c65ae14a1586a8e98525bb0896,", "verificationStatus": "VERIFIED", "createdAt": "2020-04-26T09:44:23.065Z" } | ||
<< | No Content | |
E-DI-4011 | Unable to resolve domain |
E-DI-4012 | Unable to find matching TXT record on domain |
E-DI-4020 | Unknown error |
E-DI-4021 | The file content did not match the expected value |
E-DI-4022 | Unexpected HTTP status |
E-DI-4023 | Unable to connect to the host |
A paged list of items. Use the nextPageToken in follow-up requests to step through all available items. nextPageToken will be null on the last page.
items | array | A list of items | |
count | integer | The number of items in the list | |
pageToken | string | The token for the current page | |
nextPageToken | string | NULL | The token for the next page |
A domain
id | string | The Domain ID | |
domainName | string | The name of the Domain | |
createdAt | string ISO-8601 Date & Time | The time the Domain was created | |
verificationCode | string | The code used to verify the Domain | |
verificationStatus | string VERIFIED NOT_VERIFIED |
An error object
code | string | The error code | |
message | string | A descriptive error message |
If you have any questions you can't find the answer for, please don't hesitate to contact us.