Datasets:
davidfant
/
rapidapi-example-responses

Dataset card Data Studio Files Community
1
id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
⌀
api_score
float64
0
10
⌀
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
⌀
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5a68b1b0-06e5-4fe2-9b51-32b1bc51da04/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_integration_api_v1_app__app_id__integration__post
Create an integration.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5a68b1b0-06e5-4fe2-9b51-32b1bc51da04/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_integration_api_v1_app__app_id__integration__post
Create an integration.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5a68b1b0-06e5-4fe2-9b51-32b1bc51da04/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_integration_api_v1_app__app_id__integration__post
Create an integration.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5a68b1b0-06e5-4fe2-9b51-32b1bc51da04/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_integration_api_v1_app__app_id__integration__post
Create an integration.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5a68b1b0-06e5-4fe2-9b51-32b1bc51da04/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_integration_api_v1_app__app_id__integration__post
Create an integration.
201
null
{"name": "Example Integration", "id": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "IntegrationOut", "required": ["name", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
200
null
{"name": "Example Integration", "id": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "IntegrationOut", "required": ["name", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/4f207f0f-6d0b-453a-827e-3530a74418ea/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_integration_api_v1_app__app_id__integration__integ_id___get
Get an integration.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/142de64b-fa1f-49cf-bcdd-b165d6a46eae/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. msg_id: Use a message id or a message eventId
200
null
{"data": [{"id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2", "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2", "endpointId": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "response": "{}", "responseStatusCode": 200, "timestamp": "", "status": 0, "triggerType": 0}], "iterator": "iterator", "prevIterator": "-iterator", "done": true}
{"title": "ListResponse[MessageAttemptOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "MessageAttemptOut", "required": ["id", "msgId", "endpointId", "response", "responseStatusCode", "timestamp", "status", "triggerType"], "type": "object", "properties": {"id": {"title": "Id", "type": "string"}, "msgId": {"title": "Msgid", "type": "string"}, "endpointId": {"title": "Endpointid", "type": "string"}, "response": {"title": "Response", "type": "string"}, "responseStatusCode": {"title": "Responsestatuscode", "type": "integer"}, "timestamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "status": {"title": "MessageStatus", "enum": [0, 1, 2, 3], "type": "integer", "description": "The sending status of the message:\n- Success = 0\n- Pending = 1\n- Fail = 2\n- Sending = 3", "x-enum-varnames": ["Success", "Pending", "Fail", "Sending"]}, "triggerType": {"title": "MessageAttemptTriggerType", "enum": [0, 1], "type": "integer", "description": "The reason an attempt was made:\n- Scheduled = 0\n- Manual = 1", "x-enum-varnames": ["Scheduled", "Manual"]}}}}, "iterator": {"title": "Iterator", "type": "string"}, "prevIterator": {"title": "Previterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/21b2f452-3498-4568-8c44-9a34348d793d/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put
Set the additional headers to be sent with the webhook
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/21b2f452-3498-4568-8c44-9a34348d793d/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put
Set the additional headers to be sent with the webhook
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/21b2f452-3498-4568-8c44-9a34348d793d/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put
Set the additional headers to be sent with the webhook
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/21b2f452-3498-4568-8c44-9a34348d793d/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put
Set the additional headers to be sent with the webhook
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/21b2f452-3498-4568-8c44-9a34348d793d/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put
Set the additional headers to be sent with the webhook
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
200
null
{"key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"}
{"title": "EndpointSecretOut", "required": ["key"], "type": "object", "properties": {"key": {"title": "Key", "pattern": "^whsec_[a-zA-Z0-9+/]{32}$", "type": "string", "description": "The endpoint's verification secret. If `null` is passed, a secret is automatically generated."}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/9ac47278-e298-4b74-8486-efcf93fa70bf/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/b568f697-2235-41da-afa2-d2349b038918/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_integration_api_v1_app__app_id__integration__integ_id___delete
Delete an integration and revoke it's key.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/b568f697-2235-41da-afa2-d2349b038918/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_integration_api_v1_app__app_id__integration__integ_id___delete
Delete an integration and revoke it's key.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/b568f697-2235-41da-afa2-d2349b038918/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_integration_api_v1_app__app_id__integration__integ_id___delete
Delete an integration and revoke it's key.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/b568f697-2235-41da-afa2-d2349b038918/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_integration_api_v1_app__app_id__integration__integ_id___delete
Delete an integration and revoke it's key.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/b568f697-2235-41da-afa2-d2349b038918/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_integration_api_v1_app__app_id__integration__integ_id___delete
Delete an integration and revoke it's key.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
200
null
{"data": [{"id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2", "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2", "endpointId": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "response": "{}", "responseStatusCode": 200, "timestamp": "", "status": 0, "triggerType": 0}], "iterator": "iterator", "prevIterator": "-iterator", "done": true}
{"title": "ListResponse[MessageAttemptOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "MessageAttemptOut", "required": ["id", "msgId", "endpointId", "response", "responseStatusCode", "timestamp", "status", "triggerType"], "type": "object", "properties": {"id": {"title": "Id", "type": "string"}, "msgId": {"title": "Msgid", "type": "string"}, "endpointId": {"title": "Endpointid", "type": "string"}, "response": {"title": "Response", "type": "string"}, "responseStatusCode": {"title": "Responsestatuscode", "type": "integer"}, "timestamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "status": {"title": "MessageStatus", "enum": [0, 1, 2, 3], "type": "integer", "description": "The sending status of the message:\n- Success = 0\n- Pending = 1\n- Fail = 2\n- Sending = 3", "x-enum-varnames": ["Success", "Pending", "Fail", "Sending"]}, "triggerType": {"title": "MessageAttemptTriggerType", "enum": [0, 1], "type": "integer", "description": "The reason an attempt was made:\n- Scheduled = 0\n- Manual = 1", "x-enum-varnames": ["Scheduled", "Manual"]}}}}, "iterator": {"title": "Iterator", "type": "string"}, "prevIterator": {"title": "Previterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2b54f42f-2fb2-47dc-be0b-d3f291297354/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get
List attempts by endpoint id
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/31be4133-9b99-4d0a-ad50-9bfcab30580e/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
health_api_v1_health__get
Verify the API server is up and running.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
200
null
{"uid": "unique-endpoint-identifier", "url": "https://example.com/webhook/", "version": 1, "description": "An example endpoint name", "filterTypes": [], "channels": ["project_1337"], "disabled": false, "rateLimit": 1000, "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "EndpointOut", "required": ["url", "version", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"uid": {"title": "Uid", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string", "description": "Optional unique identifier for the endpoint"}, "url": {"title": "Url", "maxLength": 65536, "minLength": 1, "type": "string", "format": "uri"}, "version": {"title": "Version", "exclusiveMinimum": false, "type": "integer"}, "description": {"title": "Description", "type": "string", "default": ""}, "filterTypes": {"title": "Filtertypes", "minItems": 1, "uniqueItems": true, "type": "array", "items": {"type": "string"}}, "channels": {"title": "Channels", "maxItems": 10, "minItems": 1, "uniqueItems": true, "type": "array", "items": {"maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "description": "List of message channels this endpoint listens to (omit for all)"}, "disabled": {"title": "Disabled", "type": "boolean", "default": false}, "rateLimit": {"title": "Ratelimit", "exclusiveMinimum": false, "type": "integer"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/916e8ae3-bb06-4776-acb5-233cdec5e830/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get
Get an application.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
200
null
{"url": "https://app.svix.com/login#key=eyJhcHBJZCI6ICJhcHBfMXRSdFl", "token": "appsk_kV3ts5tKPNJN4Dl25cMTfUNdmabxbX0O"}
{"title": "DashboardAccessOut", "required": ["url", "token"], "type": "object", "properties": {"url": {"title": "Url", "maxLength": 65536, "minLength": 1, "type": "string", "format": "uri"}, "token": {"title": "Token", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/3fca700c-0c8c-4bc5-9a2d-4a6aa2899d62/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/724a3a97-eeb1-41e5-92ad-463f830b970d/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch
Partially set the additional headers to be sent with the webhook
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/724a3a97-eeb1-41e5-92ad-463f830b970d/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch
Partially set the additional headers to be sent with the webhook
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/724a3a97-eeb1-41e5-92ad-463f830b970d/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch
Partially set the additional headers to be sent with the webhook
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/724a3a97-eeb1-41e5-92ad-463f830b970d/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch
Partially set the additional headers to be sent with the webhook
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/724a3a97-eeb1-41e5-92ad-463f830b970d/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch
Partially set the additional headers to be sent with the webhook
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
200
null
{"uid": "unique-endpoint-identifier", "url": "https://example.com/webhook/", "version": 1, "description": "An example endpoint name", "filterTypes": [], "channels": ["project_1337"], "disabled": false, "rateLimit": 1000, "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "EndpointOut", "required": ["url", "version", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"uid": {"title": "Uid", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string", "description": "Optional unique identifier for the endpoint"}, "url": {"title": "Url", "maxLength": 65536, "minLength": 1, "type": "string", "format": "uri"}, "version": {"title": "Version", "exclusiveMinimum": false, "type": "integer"}, "description": {"title": "Description", "type": "string", "default": ""}, "filterTypes": {"title": "Filtertypes", "minItems": 1, "uniqueItems": true, "type": "array", "items": {"type": "string"}}, "channels": {"title": "Channels", "maxItems": 10, "minItems": 1, "uniqueItems": true, "type": "array", "items": {"maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "description": "List of message channels this endpoint listens to (omit for all)"}, "disabled": {"title": "Disabled", "type": "boolean", "default": false}, "rateLimit": {"title": "Ratelimit", "exclusiveMinimum": false, "type": "integer"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a671a253-71e8-4b74-88ed-35033b4dcb8c/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put
Update an endpoint.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/029b7251-6dc1-46e4-9a9f-1290915278e7/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete
Delete an endpoint.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/029b7251-6dc1-46e4-9a9f-1290915278e7/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete
Delete an endpoint.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/029b7251-6dc1-46e4-9a9f-1290915278e7/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete
Delete an endpoint.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/029b7251-6dc1-46e4-9a9f-1290915278e7/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete
Delete an endpoint.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/029b7251-6dc1-46e4-9a9f-1290915278e7/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete
Delete an endpoint.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/75745040-b69b-4b42-b8d5-765a48f83547/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_integration_api_v1_app__app_id__integration__integ_id___put
Update an integration.
200
null
{"name": "Example Integration", "id": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "IntegrationOut", "required": ["name", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
200
null
{"description": "A user has signed up", "schemas": {"example": {"invoiceId": "", "userId": ""}}, "archived": false, "name": "user.signup", "createdAt": "", "updatedAt": ""}
{"title": "EventTypeOut", "required": ["description", "name", "createdAt", "updatedAt"], "type": "object", "properties": {"description": {"title": "Description", "type": "string"}, "schemas": {"title": "Schemas", "type": "object", "additionalProperties": {"type": "object"}, "description": "The schema for the event type for a specific version as a JSON schema."}, "archived": {"title": "Archived", "type": "boolean", "default": false}, "name": {"title": "Name", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0a092056-49a3-41d2-8afc-fcf5540ae48c/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_event_type_api_v1_event_type__event_type_name___get
Get an event type.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
200
null
{"data": [{"name": "Example Integration", "id": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}], "iterator": "iterator", "done": true}
{"title": "ListResponse[IntegrationOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "IntegrationOut", "required": ["name", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}}, "iterator": {"title": "Iterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/0d4622d1-e442-4daa-bd52-2b4f675b0948/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_integrations_api_v1_app__app_id__integration__get
List the application's integrations.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/a6082070-fbc5-447a-84a4-103234349087/6/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
400
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
200
null
{"headers": {}, "sensitive": ["X-Foobar"]}
{"title": "EndpointHeadersOut", "required": ["headers", "sensitive"], "type": "object", "properties": {"headers": {"title": "Headers", "type": "object", "additionalProperties": {"type": "string"}}, "sensitive": {"title": "Sensitive", "uniqueItems": true, "type": "array", "items": {"type": "string"}}}, "description": "The value of the headers is returned in the `headers` field.\n\nSensitive headers that have been redacted are returned in the sensitive field."}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/77573932-d93c-46e8-a01e-b6dc499f2814/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get
Get the additional headers to be sent with the webhook
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
422
null
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}